RESTful-URL-Design für die Suche nach einer einzelnen Ressource

Question

Es wurde eine couple von questions in Bezug auf RESTful URL-Design für die Suche nach Ressourcen. Was mich interessiert, ist eine RESTful-URL für eine einzelne Ressource durch etwas anderes als die Ressourcen-ID.

Zum Beispiel hat ein Benutzer eine ID und eine Ressourcen-URL /rest/user/<id>. Ich möchte die Suche nach einem einzelnen Benutzer über seine E-Mail-Adresse zulassen (die vom System als eindeutig angesehen wird).

Alternativen Ich habe kommen mit:

A) /rest/user/email/john.doe@example.com - eine separate Ressource erstellen, die einzelne Ressource für den Zugriff auf (obwohl /rest/user/email würde /rest/user/email:john.doe@example.com)

B) undefiniert - hier email:john.doe@example.com gilt als eine alternative Kennung für den Benutzer, also dies ist der gleiche Ressource Endpunkt mit einer alternativen ID

C) /rest/user?email=john.doe@example.com - das ist RESTful Suche, aber es würde zurückkehren n ein Array mit null oder einem Eintrag, und somit ist kein direkter Bezug auf die Ressource

D) /rest/user/search?email=john.doe@example.com - ähnliche Suche API als (C), aber mit unterschiedlicher Semantik

Die Konstruktion sollte mit dem Suchen erweiterbar verschiedene eindeutige IDs, die vom System bereitgestellt werden (externe ID, Telefonnummer, SSN usw.).

Ich orientiere mich an Option B, da sie eine alternative Möglichkeit zur Referenzierung eines bestimmten Benutzers (die global im Service verwendet werden kann) definiert und vorhandene Ressourcenendpunkte wiederverwendet. Dies könnte sowohl auf PUT und DELETE als auch auf GET erweitert werden. Aber ist es sehr RESTful?

Answer 1

/rest/user/search?email=john.doe@example.com, der Schrägstrich '/', der zum Darstellen der Ebenenbeziehung verwendet wird, z./rest/customer/orders/order1, customer hat die sammlung von aufträgen, orders hat eine bestellung namens order1.