RESTful Web Services - Adressierung
Adressierung bezieht sich auf das Auffinden einer Ressource oder mehrerer Ressourcen, die auf dem Server liegen. Es ist analog, eine Postanschrift einer Person zu finden.
Jede Ressource in der REST-Architektur wird durch ihren URI (Uniform Resource Identifier) identifiziert. Ein URI hat das folgende Format:
<protocol>://<service-name>/<ResourceType>/<ResourceID>Zweck einer URI ist das Auffinden einer Ressource auf dem Server, auf dem sich der Webdienst befindet. Ein weiteres wichtiges Attribut einer Anforderung ist VERB, das die an der Ressource auszuführende Operation identifiziert. Im Kapitel RESTful Web Services - Erste Anwendung lautet der URI beispielsweisehttp://localhost:8080/UserManagement/rest/UserService/users und das VERB ist GET.
Erstellen einer Standard-URI
Das Folgende sind wichtige Punkte, die beim Entwerfen einer URI berücksichtigt werden müssen:
Use Plural Noun- Verwenden Sie das Substantiv Plural, um Ressourcen zu definieren. Beispielsweise haben wir Benutzer verwendet, um Benutzer als Ressource zu identifizieren.
Avoid using spaces- Verwenden Sie bei Verwendung eines langen Ressourcennamens einen Unterstrich (_) oder einen Bindestrich (-). Verwenden Sie beispielsweise autorisierte Benutzer anstelle von autorisierten% 20-Benutzern.
Use lowercase letters - Obwohl bei URI die Groß- und Kleinschreibung nicht berücksichtigt wird, empfiehlt es sich, die URL nur in Kleinbuchstaben zu halten.
Maintain Backward Compatibility- Da der Webdienst ein öffentlicher Dienst ist, sollte ein einmal veröffentlichter URI immer verfügbar sein. Falls der URI aktualisiert wird, leiten Sie den älteren URI mithilfe des HTTP-Statuscodes 300 auf einen neuen URI um.
Use HTTP Verb- Verwenden Sie immer HTTP-Verben wie GET, PUT und DELETE, um die Operationen an der Ressource auszuführen. Es ist nicht gut, den Operationsnamen in der URI zu verwenden.
Beispiel
Das folgende Beispiel zeigt einen schlechten URI zum Abrufen eines Benutzers.
http://localhost:8080/UserManagement/rest/UserService/getUser/1Im Folgenden finden Sie ein Beispiel für einen guten URI zum Abrufen eines Benutzers.
http://localhost:8080/UserManagement/rest/UserService/users/1