REST - コンテンツ内のリンクの書式設定方法

Question

RESTではリンクについてのすべてです。基本的に、APIユーザーは1つのリンク、トップレベルリンクのみを必要とします。これは通常http://server/api/などです。他のすべてのリンクは、階層をブラウズしている間に検出されます。例えば、/APIをGET/はあなたに/API /ユーザー/と/API /画像/と/API /ユーザーへのリンクを与えるかもしれない/あなた/API /ユーザーへのリンクを与えるかもしれません/ john/など。

これらのリンクをどのようにフォーマットするのか何らかの標準があるかどうかは疑問です。結局のところ、リンクに関するすべての場合、クローラは、システムのすべてのリソースを最初から調べることができるはずです。

私はいくつかの研究を行った。 XMLメディアタイプであり、注目すべき標準を見つけることができませんでした。 /users/のリソースを選択しましょう。

<users> 
    <user name='john' xlink:href='/users/john'/> 
    <user name='steve' xlink:href='/users/steve'/> 
</users> 

などなど：いくつかは

<users> 
    <user name='john' uri='/users/john'/> 
    <user name='steve' uri='/users/steve'/> 
</users> 

その他

<users> 
    <user name='john' link='/users/john'/> 
    <user name='steve' link='/users/steve'/> 
</users> 

その他には、例えば与えXLINKを、使用書きます。

ここではわかりませんが、他のリソースへのリンクをどのようにフォーマットするかを指定する標準がないはずです。データがどのようにフォーマットされているかについての知識はありません。言い換えると、アプリケーションA1のAPIのクローラXは、アプリケーションA2のAPIに対してはおそらく機能しません。なぜなら、A1はA2とは異なるリソースへのリンクをフォーマットするからです。

上記では、私はXMLメディアタイプについてのみ話していました。 JSONを使用すると、さらに多くのバージョンが現場に広がっています。

リソースの関連リソースへのリンクをどのようにフォーマットする必要があるのか​​を指定しなかったのはなぜですか？

Answer 1

application/xmlを返す際の問題は、リンクを指定するための標準的なセマンティクスが定義されていないことです。だから、それは非常に良いハイパーメディアのメディアタイプではありません。 Xhtmlは、リンクのいくつかのルールを指定する優れたものです。 HALは、さらに簡単なもう1つの優れたものです。

文書内にリンクを指定する際には、hrefだけでなく、多くの点を考慮する必要があります。 Mike Amundsen氏はhfactorでいくつかの素晴らしい仕事をしており、ドキュメントへのリンクを埋め込むさまざまな側面について話しています。

リンクの最も重要な部分は、John Howesがrelを述べたようなものです。 relは、IANAとしてhereと定義されたもののように、グローバルに定義されたものでもよい。または、RFC 5988で定義されている拡張リンク関係のルールに従っている限り、独自のカスタムルールにすることができます。 relドキュメントは、クライアント開発者に、そのリンクのアクティブ化について知っておく必要があることをすべて伝えます。

Answer 2

リソースの関連リソースへのリンクをフォーマットする方法を指定しなかったのはなぜですか？

ダレルは、上記の良いテイクを持っていますが、直接あなたの質問に答えるために：RESTスタイルで、それは、それはメディアタイプを利用するプロトコルを使用するアーキテクチャで実現されています。リンクがどのようにフォーマットされるべきかを指定するメディアタイプとされている。したがって、REST自体は書式設定を指定しません。これは、標準タイプがリンク書式を指定するデータ要素の対話の配置を制約する方法を指定します。