ベストアンサー1
TL;DR: RESTful API 設計のベスト プラクティスは、パス パラメータを使用して特定のリソースを識別し、クエリ パラメータを使用してそれらのリソースを並べ替え/フィルター処理することです。
次に例を示します。Carというエンティティの RESTful API エンドポイントを実装しているとします。エンドポイントは次のように構成します。
GET /cars
GET /cars/:id\ POST /cars\ PUT /cars/:id\ DELETE/cars/:id
この方法では、取得するリソースを指定するときにのみパス パラメータを使用しますが、リソースの並べ替えやフィルタリングは一切行われません。
ここで、GET リクエストで車を色でフィルタリングする機能を追加したいとします。色はリソースではない (リソースのプロパティ) ため、これを行うクエリ パラメータを追加できます。そのクエリ パラメータをGET/carsリクエストに追加するには、次のようにします。
得る/cars?color=blue
このエンドポイントは、青い車だけが返されるように実装されます。
次のシンボルを使用して、さらにフィルタリング パラメータを追加できます&。
得る/cars?color=blue&brand=ferrari
構文に関しては、URL名はすべて小文字にする必要があります。エンティティ名が英語で一般的に2つの単語で構成される場合は、単語をハイフンで区切る必要があります。キャメルケース。
例/two-words