Wie benennt man eine REST-API, die eine Liste von Bestellungen zurückgibt, die zu bestimmten Benutzern gehört?

Question

Wir haben eine REST-API

/accounts/{user_id}/shop/orders 

alle Aufträge zurück, die zu einem Benutzer gehört.

Jetzt füge ich neue API hinzu, die Bestellungen nach bestimmten Bestellnummern zurückgibt.

/accounts/{user_id}/shop/orders/order?orders=a,b,c,d 

Ich kann die neue API zum ursprünglichen /accounts/{user_id}/shop/orders nennen, weil ich Zuordnung zu verschiedenen Controller es will.

Aber ich denke, /accounts/{user_id}/shop/orders/order?orders=a,b,c,d ist ein bisschen komisch, also was ist der bessere Name für diesen Fall?

Answer 1

Hier ist ein Vorschlag, den ich gesehen habe, der ab und zu verwendet wird, der in Ihrer Situation arbeiten könnte, wenn Sie müssen unterschiedliche Endpunkte für die 2 Controller haben.

Um alle Aufträge zurück, die zu einem Benutzer gehört:

/accounts/{user_id}/shop/orders/all 

oder

/accounts/{user_id}/shop/orders/list 

(Ich mag die erste besser, da die zweite man nicht bedeutet, dass die Liste vollständig ist)

Um Aufträge von Bestellnummern zurück:

/accounts/{user_id}/shop/orders/filtered?number=a,b,c,d 

Auf diese Weise können Sie sie beide durch /accounts/{user_id}/shop/orders, was nett ist, da sie beide dorthin gehören, aber immer noch in der Lage, deutlich zwischen den Funktionen der 2 Endpunkte unterscheiden können.