機械翻訳について

RESTリソース・タイプ

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

単数リソース

単一のリソースは、カテゴリやロケールなどの単一のエンティティを表し、次のことができます:

• 子リソースを含む階層構造を使用します。
• HATEOASをサポートするlinksプロパティが含まれます。これは、リソースの重要な制約です。 このプロパティは、関連リソースへのリンクを定義するために使用されます。

次の表では、リンク・オブジェクトのプロパティについて説明します。

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

収集リソース

コレクション・リソースは、カテゴリやリポジトリのリストなど、アイテムのリストを表します。 収集リソースは次のことができます:

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

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

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