rest - 安らかな Web サービスでデータの範囲または複数のエンティティを指定する方法

Question

安らかな Web サービスで User のインスタンスにアクセスするには、URL は以下の curl リクエストに示すように構成されます。

curl -v -X GET -s  "$BASE_URL/User/${customer_id}.json"

データベース内の最初の 50 人のユーザーなど、一連のユーザー エンティティを介してすべてのユーザー エンティティまたはページを指定したい場合、REST に準拠するようにリクエストをどのように構成しますか ???

Answer 1

URI 内の文字の意味を強調しないようにすることから始める必要があります。きれいで読みやすい URI は良いことですが、REST とは何の関係もありません。実際、すべての URI を意味のない文字列に変更して RESTful インターフェイスの設計を判断し、後でかわいらしさを追加することは良い練習になります。クライアントは、サーバーの URI 構造をまったく認識してはなりません。これは、サーバーが後で変更できないという単純な理由からです。

次に、顧客のリストがあなたにとって意味のある概念である場合は、必ずそれを独自のリソースに変える必要があります。その表現では、個々の顧客に関する情報と、個々の顧客リソースへのリンクを含めることができます。

ページング？良いアイデアです。各ページを独自のリソースに変えて、それらをリンクしてください。Google がヒントとして検索結果を表示する方法を見てみましょう。

多くの場合、クライアントがページ サイズを指定できる必要はないため、これで十分です。しかし、そうである場合、基本的に 2 つのオプションがあります。フォームをカプセル化するリソースを使用して、送信時にリダイレクトを介して直接的または間接的に適切な URI に移動するパラメーターを指定できるようにすることができます。または、貧乏人のフォーム、URI テンプレートを含めることもできます。

いずれにしても、最初のポイントを繰り返します。RESTful インターフェイスを、一連の URI 構築ルールとして現れる API と見なさないでください。代わりに、リソース、表現、ハイパーメディアについて考えてください。