ユーザーが単一のGETリクエストで単一の製品または製品のリストを取得できるRESTful APIを設計しようとしています。各製品には一意のIDがあります。
単一の製品URLは非常に単純です。
http://mycompany.com/api/v1/product/id
これは、単一の製品の情報を返します。複数の製品情報のURLがどのように見えるかについて、私は混乱しています。
どう?
http://mycomapny.com/api/v1/product/ids
idsはコンマで区切られたIDのリストですか?
コンマで区切られたIDの提案で十分です。
いくつかのpublic REST APIを調べて、それらの処理方法を確認することは有益です。たとえば、StackExchange APIは、セミコロンでIDを区切ります- https://api.stackexchange .com/docs/answers-by-ids
Idでフィルタリングされたリソースの複数の表現をリストしているように考えることをお勧めします。そのため、ベースリソースに対してGET
リクエストを作成します。
https://example.com/api/v1/products
そして、id
で応答リストをフィルタリングします:
https://example.com/api/v1/products?id=1,2,3