Адресация относится к поиску ресурса или нескольких ресурсов, лежащих на сервере. Это аналогично поиску почтового адреса человека.
Каждый ресурс в архитектуре REST идентифицируется своим URI (унифицированным идентификатором ресурса). URI имеет следующий формат —
<protocol>://<service-name>/<ResourceType>/<ResourceID>
Назначение URI — найти ресурс (ы) на сервере, на котором размещен веб-сервис. Другим важным атрибутом запроса является VERB, который идентифицирует операцию, выполняемую над ресурсом. Например, в главе RESTful Web Services — первое приложение URI является http: // localhost: 8080 / UserManagement / rest / UserService / users, а VERB — GET.
Построение стандартного URI
Ниже приведены важные моменты, которые необходимо учитывать при разработке URI:
-
Использовать множественное число — используйте множественное число, чтобы определить ресурсы. Например, мы использовали пользователей для идентификации пользователей как ресурса.
-
Избегайте использования пробелов — используйте подчеркивание (_) или дефис (-) при использовании длинного имени ресурса. Например, используйте author_users вместо авторизованных% 20users.
-
Используйте строчные буквы — хотя в URI регистр не учитывается, рекомендуется хранить URL только в строчных буквах.
-
Поддерживать обратную совместимость — поскольку веб-служба является общедоступной, всегда должен быть доступен URI, который когда-то был открыт. В случае обновления URI перенаправьте старый URI на новый URI, используя код состояния HTTP 300.
-
Использовать HTTP-глагол — всегда используйте HTTP-глагол, например GET, PUT и DELETE, чтобы выполнять операции с ресурсом. Неправильно использовать имя операции в URI.
Использовать множественное число — используйте множественное число, чтобы определить ресурсы. Например, мы использовали пользователей для идентификации пользователей как ресурса.
Избегайте использования пробелов — используйте подчеркивание (_) или дефис (-) при использовании длинного имени ресурса. Например, используйте author_users вместо авторизованных% 20users.
Используйте строчные буквы — хотя в URI регистр не учитывается, рекомендуется хранить URL только в строчных буквах.
Поддерживать обратную совместимость — поскольку веб-служба является общедоступной, всегда должен быть доступен URI, который когда-то был открыт. В случае обновления URI перенаправьте старый URI на новый URI, используя код состояния HTTP 300.
Использовать HTTP-глагол — всегда используйте HTTP-глагол, например GET, PUT и DELETE, чтобы выполнять операции с ресурсом. Неправильно использовать имя операции в URI.
пример
Ниже приведен пример плохого URI для выборки пользователя.
http://localhost:8080/UserManagement/rest/UserService/getUser/1
Ниже приведен пример хорошего URI для выборки пользователя.