1. REST API

リンクス

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Sitecore Content Hub REST APIはハイパーメディアAPIであるため、リソース間のリンクは重要な役割を果たします。APIの任意のリソースには、適切なリンクをたどることにより、サービス エンドポイントからアクセスできます。

主な理由は、クライアント (および一部のサーバー) が表現の場所を表現と共に保存しないことです。たとえば、get http://.../foo.jsonリクエストを送信すると、表現はディスクに保存されますが、フェッチされたURIは保存されません。表現に「自己」リンクが埋め込まれていない場合、次の2つの問題が発生します。

  1. ドキュメント内の相対リンクは、解決するためのベースがなくなった場合があるため、「壊れた」状態になります

  2. クライアントには、ドキュメントを変更する場合にサーバーにPUTを戻すなど、どこに挿入するかについての概念が組み込まれていません。

表現はHTTP会話のかなり外側で存在し、他のプロトコル (電子メール、FTP、書籍など) を介して転送される可能性があることを理解することが重要です。したがって、リンクオブジェクトは 、ほとんどすべてのリソースに存在する重要なオブジェクトです。

「self」リンクの使用方法の詳細については、Roy Fieldingによるこの優れた記事「 REST APIs must be hypertext-driven 」と、Stack Overflowに関するこれらのディスカッションを参照してください。「 ハイパーメディアAPIにおけるセルフリンクの重要性は何ですか?」 および 「REST API内の別のリソースへのリンク:そのIDによって、またはそのURLによって」を参照してください。

この記事を改善するための提案がある場合は、 お知らせください!