Веб-службы RESTful - адресация

Адресация относится к обнаружению ресурса или нескольких ресурсов, лежащих на сервере. Это аналогично поиску почтового адреса человека.

Каждый ресурс в архитектуре REST идентифицируется своим URI (унифицированным идентификатором ресурса). URI имеет следующий формат -

<protocol>://<service-name>/<ResourceType>/<ResourceID>

Цель URI - найти ресурс (ы) на сервере, на котором размещена веб-служба. Еще одним важным атрибутом запроса является VERB, который определяет операцию, которая должна быть выполнена над ресурсом. Например, в главе « Веб-службы RESTful - Первое приложение» URI-адресhttp://localhost:8080/UserManagement/rest/UserService/users а ГЛАГОЛ - ПОЛУЧИТЬ.

Создание стандартного URI

Следующие важные моменты следует учитывать при разработке URI:

  • Use Plural Noun- Используйте существительное во множественном числе для определения ресурсов. Например, мы использовали пользователей для идентификации пользователей как ресурса.

  • Avoid using spaces- Используйте подчеркивание (_) или дефис (-) при использовании длинного имени ресурса. Например, используйте authorized_users вместо авторизованных% 20users.

  • Use lowercase letters - Хотя в URI регистр не учитывается, рекомендуется использовать в URL только строчные буквы.

  • Maintain Backward Compatibility- Поскольку веб-служба является общедоступной, URI-адрес, однажды обнародованный, всегда должен быть доступен. В случае обновления URI перенаправьте старый URI на новый URI, используя код состояния HTTP, 300.

  • Use HTTP Verb- Всегда используйте HTTP-глагол, например GET, PUT и DELETE, для выполнения операций с ресурсом. Не рекомендуется использовать имя операции в URI.

пример

Ниже приведен пример неправильного URI для выборки пользователя.

http://localhost:8080/UserManagement/rest/UserService/getUser/1

Ниже приведен пример хорошего URI для выборки пользователя.

http://localhost:8080/UserManagement/rest/UserService/users/1