RESTリソース・タイプ
2つのタイプのRESTリソースについて説明: 「単数リソース」と呼ばれる単一のエンティティ、および「コレクション・リソース」と呼ばれる品目の結合リスト。
単数リソース
単数リソースは、従業員や購買オーダーなどの単一のエンティティを表し、次のことができます:
-
子リソースを含む階層構造を使用します。
-
アプリケーション状態のエンジン(HATEOAS)としてHypermediaをサポートする
linksプロパティを含めます。これは、関連リソースへのリンクの定義に使用されるリソースの重要な機能です。
次の表では、リンク・オブジェクトのプロパティについて説明します。
| プロパティ | 説明 |
|---|---|
rel |
リンク・オブジェクトとターゲット・リソースの関係を定義します。 リンクには次のタイプがあります:
|
href |
リソースにアクセスするためのURL。 |
name |
リンクの一意の識別子。 |
kind |
リンクが参照するターゲット・リソースのタイプを示します。 有効な値は、 |
ノート:
リソースに定義されたLOVの摘要にサポートされていないと示されている場合は、LOVを使用しないことをお薦めします。 LOVの説明は、Request > Relationships > <LOV name>の「タスク」セクションで確認できます。
回収リソース
収集リソースは、従業員のリストや購買オーダーなど、品目のリストを表します。 収集リソースは次のことができます:
-
linksプロパティを使用して、単一のリソースを拡張します。 -
ページ区切りレスポンスを実装できるように、部分的なリクエストをサポートします。 RESTクライアントは、コレクションの一部を1つのリクエストで取得し、その後に次または前の部分に対する後続のリクエストを取得できます。 このナビゲーションをサポートするために、リンク・セクションには前のページおよび次のページへのリンクを含めることができます。
-
ルート・リソースまたはサブリソースとして機能します。
-
同じタイプの単数形のリソースの配列を含めます。
-
クライアントが
orderByコマンドを使用して、返される品目の順序を指定できます。 (それ以外の場合は、順序を決定できません。)
次の表に、コレクション・リソースの問合せおよびページング・パラメータを示します。
| パラメータ | 説明 |
|---|---|
items |
コレクション内のレコードの配列。 各品目またはレコードは単一のリソースです。 |
hasMore |
取得する品目が他にあるかどうかを示すブール値。 有効な値は次のとおりです。
|
totalResults |
レスポンス内のリソース・インスタンスの合計数を指定する整数値。 現在のレスポンスのインスタンスと、まだ取得されていないインスタンスが含まれます。 |
limit |
サーバーがクライアント・リクエストに使用するページング・サイズを指定する整数値。 デフォルト値は、25です。 アプリケーションのパフォーマンスを向上させるために、サーバーがこの値をオーバーライドする場合があります。 |
count |
ページング・レスポンス内の品目数を指定する整数値。 この値は、 |
offset |
返される最初のアイテムの索引を指定する整数値。 デフォルト値は、0です。 たとえば:
|
詳細は、「コレクションの管理」を参照してください。