特定のポイント(URIと他の適切なリソースとのリンク)に一連のアクションをクライアントに提供するためにアプリケーションにハイパーメディアを実装することを検討している場合は、/things
URIはGETを送信するのに理想的な場所ですこれらのリンク。
以下は、/things
リソースのGETのサンプル結果です。このアプローチの利点は、クライアントがLinks
のRel
値を検索する代わりに、URIの構築方法を「知る」必要があるようにコード化できることです。クライアントがURIを構築する必要がある場合でも、検索リンクhrefに{searchTerm}
のような項目を検索し、適切な値に置き換えるようにコード化することができます。
"Things": [
{
"Description": "Resource level properties that make sense to put here",
"Count": 33,
"Links": [
{
"Rel": "self",
"Method": "GET",
"Href": "http://yourDomain/things",
"Title": "Things resource"
}
]
}
],
"Navigation": [
{
"Links": [
{
"Rel": "GetItem",
"Method": "GET",
"Href": "http://yourDomain/things/{id}",
"Title": "Get a single item"
},
{
"Rel": "Search",
"Method": "GET",
"Href": "http://yourDomain/things/?searchTerm={searchTerm}&itemsPerCall={itemsPerCall}",
"Title": "Search items per term"
}
]
}
]