リソースの要約表現をリクエストするREST APIの最良の方法は？

Question

私は大きなリソース、顧客を扱うREST APIを持っています。顧客は時には顧客の略式/略式表現を望んでいる。要求がサマリー表現のためのものであることを指定する良い方法は何でしょうか？

は、顧客123のための完全な表現を取得するには、その：要約表現は /customers/123/summary良い方法です /customers/123

取得するには？ 良いオプションはありますか？

Answer 1

ソリューションを再利用可能かつ柔軟にするために、「フィルタ」クエリパラメータを実装することをお勧めします。そこでは、あなたがクライアントに必要なフィールドを置くことができます。

GET /customers/123?fields=id,first_name,last_name,email 

その方法を、後であなたが別のタスクごとに異なる要約を作成する必要がある場合は、変更には何もありません。

フレキシブルではないので、/customers/123/summaryはおすすめしません。 1つのケースでは問題ありませんが、クライアントが別のケースで異なるプロパティにアクセスする必要がある場合は、リソースを調整する必要があります（必要以上のフィールドを返す可能性が高い）。 「DESCRIPTIONは」要約のタイプを記述します

GET /customers/123?view=DESCRIPTION 

：あなたはフィールド名を「非表示」にしたい場合は、おそらく代替は、このようなものである可能性があります。例：

GET /customers/123?view=addresses_only // eg. returns billing and home address 
GET /customers/123?view=short // eg. returns only id, first name, last name 

これは、新しいビューを簡単に作成できるので、柔軟性があります。