アプリケーションにハイパーメディアを実装して、特定の時点で可能な一連のアクション (他の適切なリソースへの URI とのリンク) をクライアントに提供することを検討している場合、/things
URI はこれらのリンクの GET を送信する理想的な場所です。
/things
以下は、リソースに対する GET のサンプル結果です。このアプローチの利点は、URI の構築方法を「知る」必要がなく、クライアントがRel
値を検索するようにコーディングできることです。Links
クライアントが URI を作成する必要がある場合でも{searchTerm}
、検索リンクの href のようなアイテムを検索するようにコーディングして、適切な値に置き換えることができます。
"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"
}
]
}
]