Api REST : demande de plusieurs ressources en une seule fois

Question

J'essaie de concevoir une API RESTful permettant aux utilisateurs d'extraire un seul produit ou une liste de produits en une seule requête GET. Chaque produit a un identifiant unique.

L'URL unique du produit est assez simple :

http://mycompany.com/api/v1/product/id

Cela renvoie les informations relatives à un seul produit. Je ne sais pas à quoi doit ressembler l'URL pour les informations sur plusieurs produits.

Et si

http://mycompany.com/api/v1/product/ids

où ids est une liste d'ids séparés par des virgules ?

Answer 1

Je vous recommande de penser à cela comme à une liste de représentations multiples de la ressource filtrée par id. En tant que tel, vous faites un GET à la ressource de base :

https://example.com/api/v1/products

Et filtrez la liste des réponses par id :

https://example.com/api/v1/products?id=1,2,3

Answer 2

Votre suggestion d'utiliser des identifiants séparés par des virgules est suffisante.

Il serait instructif d'examiner certaines API REST publiques pour voir comment elles se comportent. Par exemple, l'API de StackExchange sépare les identifiants par un point-virgule. https://api.stackexchange.com/docs/answers-by-ids