機械翻訳について

RESTリソース・タイプ

2つのタイプのRESTリソースについて説明: 「単数リソース」と呼ばれる単一のエンティティ、および「コレクション・リソース」と呼ばれるアイテムの結合リスト。

単数リソース

単一のリソースは、従業員や購買オーダーなどの単一のエンティティを表し、次のことができます:

• 子リソースを含む階層構造を使用します。
• アプリケーション状態のエンジン(HATEOAS)としてHypermediaをサポートするlinksプロパティを含めます。これは、関連リソースへのリンクの定義に使用されるリソースの重要な機能です。

次の表に、リンク・オブジェクトのプロパティを示します。

プロパティ	説明
rel	リンク・オブジェクトとターゲット・リソースの関係を定義します。 リンクのタイプは次のとおりです: rel="self": レスポンス内のリンク・コンテキストを識別します。 rel="canonical": リソースURLの優先バージョンを指定します。 rel="child": 子リソースへのリンクを提供します。 rel="lov": フィールド値の設定に使用される値リストを含むリソースへのリンクを提供します。 rel="parent": 親リソースへのリンクを提供します。
href	リソースにアクセスするためのURL。
name	リンクの一意の識別子。
kind	リンクが参照するターゲット・リソースのタイプを示します。 有効な値は、collectionおよびitemです。

ノート:

リソースに定義されたLOVの摘要がサポートされていないと示されている場合は、LOVを使用しないことをお薦めします。 LOVの説明は、Request > Relationships > <LOV name>の「タスク」セクションで確認できます。

回収リソース

回収リソースは、従業員のリストや購買オーダーなど、品目のリストを表します。 収集リソースは次のことができます:

• linksプロパティを使用して、単一のリソースを拡張します。
• ページ区切りレスポンスを実装できるように、部分的なリクエストをサポートします。 RESTクライアントは、1つのリクエストでコレクションの一部を取得し、その後に次または前のパートに対する後続のリクエストを取得できます。 このナビゲーションをサポートするために、リンク・セクションには前のページおよび次のページへのリンクを含めることができます。
• ルート・リソースまたはサブリソースとして機能します。
• 同じタイプの単数形のリソースの配列を含めます。
• クライアントがorderByコマンドを使用して、返されるアイテムの順序を指定できます。 (それ以外の場合は、順序を決定できません。)

次の表に、コレクション・リソースの問合せおよびページング・パラメータを示します。

パラメータ	説明
items	コレクション内のレコードの配列。 各アイテムまたはレコードは単一のリソースです。
hasMore	取得するアイテムが他にあるかどうかを示すブール値。 有効な値は次のとおりです。 True - 取得する値の増加 False - 取得する値がありません
totalResults	レスポンス内のリソース・インスタンスの合計数を指定する整数値。 現在のレスポンスのインスタンスと、まだ取得されていないインスタンスが含まれます。
limit	サーバーがクライアント・リクエストに使用するページング・サイズを指定する整数値。 デフォルト値は、25です。 アプリケーションのパフォーマンスを向上させるために、サーバーがこの値をオーバーライドする場合があります。
count	ページング・レスポンス内のアイテム数を指定する整数値。 この値は、itemsパラメータの値と一致します。
offset	返される最初のアイテムの索引を指定する整数値。 デフォルト値は、0です。 たとえば: offset=0の場合、レスポンスにはコレクションの最初のアイテムから始まるすべてのアイテムが含まれます。 offset=10およびcount=20の場合、レスポンスには11から30までのリソースが含まれます。

詳細は、「コレクションの管理」を参照してください。