RESTful Web Services - adresowanie
Adresowanie odnosi się do lokalizowania zasobu lub wielu zasobów znajdujących się na serwerze. Analogiczne jest zlokalizowanie adresu pocztowego osoby.
Każdy zasób w architekturze REST jest identyfikowany za pomocą swojego URI (Uniform Resource Identifier). Identyfikator URI ma następujący format -
<protocol>://<service-name>/<ResourceType>/<ResourceID>Celem identyfikatora URI jest zlokalizowanie zasobu (ów) na serwerze obsługującym usługę internetową. Innym ważnym atrybutem żądania jest VERB, który identyfikuje operację, która ma zostać wykonana na zasobie. Na przykład w rozdziale RESTful Web Services - pierwsza aplikacja identyfikator URI tohttp://localhost:8080/UserManagement/rest/UserService/users a CZASOWNIK to GET.
Konstruowanie standardowego identyfikatora URI
Poniżej przedstawiono ważne kwestie, które należy wziąć pod uwagę podczas projektowania identyfikatora URI -
Use Plural Noun- Użyj rzeczownika w liczbie mnogiej, aby zdefiniować zasoby. Na przykład użyliśmy użytkowników do zidentyfikowania użytkowników jako zasobu.
Avoid using spaces- Użyj podkreślenia (_) lub łącznika (-), jeśli używasz długiej nazwy zasobu. Na przykład użyj Authorized_users zamiast autoryzowanych% 20users.
Use lowercase letters - Chociaż w identyfikatorze URI nie jest rozróżniana wielkość liter, dobrą praktyką jest przechowywanie adresu URL wyłącznie małymi literami.
Maintain Backward Compatibility- Ponieważ usługa sieciowa jest usługą publiczną, raz upubliczniony identyfikator URI powinien być zawsze dostępny. W przypadku, gdy identyfikator URI zostanie zaktualizowany, przekieruj starszy identyfikator URI do nowego identyfikatora URI przy użyciu kodu stanu HTTP 300.
Use HTTP Verb- Zawsze używaj czasownika HTTP, takiego jak GET, PUT i DELETE, aby wykonywać operacje na zasobie. Używanie nazwy operacji w identyfikatorze URI nie jest dobre.
Przykład
Poniżej znajduje się przykład kiepskiego identyfikatora URI do pobrania użytkownika.
http://localhost:8080/UserManagement/rest/UserService/getUser/1Poniżej znajduje się przykład dobrego identyfikatora URI do pobrania użytkownika.
http://localhost:8080/UserManagement/rest/UserService/users/1