Глубокий взгляд на REST: Принципы и методы

REST (REpresentational State Transfer) представляет собой архитектурный стиль, принципы которого направлены на создание распределенных гипермедиа систем, применяемых в World Wide Web. Он предлагает универсальные методы обработки и передачи состояния ресурсов через HTTP. Автор концепции и термина - Рой Филдинг, 2000 г.

В настоящее время REST практически заменил другие подходы, такие как SOAP и WSDL.

Рассмотрим, какие преимущества предлагает REST:

• Улучшенная масштабируемость во взаимодействиях между компонентами системы;
• Стандартизированный интерфейс;
• Возможность независимого внедрения компонентов;
• Промежуточные компоненты, минимизирующие задержки и повышающие безопасность.

Когда следует применять REST:

• Когда имеются ограничения по пропускной способности соединения;
• Если необходимо кэшировать запросы для повышения эффективности;
• В системах, предполагающих значительное масштабирование;
• В сервисах, использующих AJAX.

Преимущества REST

• Отсутствие дополнительных прослоек: данные передаются в том виде, каковы они есть, без упаковки в XML или AMF, в отличие от SOAP и Flash.
• Каждый ресурс четко идентифицируется своим URL, который выступает в качестве первичного ключа. Формат данных по адресу значения не имеет и может быть разным: от HTML до JPEG.
• Управление данными ресурса осуществляется на основе протокола передачи данных, чаще всего HTTP. В HTTP предусмотрены методы для выполнения действий над данными: GET, PUT, POST, DELETE, позволяющие реализовать операции CRUD (Create-Read-Update-Delete) различной сложностью.

Что такое RESTful?

Для признания системы RESTful, она должна удовлетворять следующим критериям:

1. Client-Server: Разделение системы на клиенты и серверы. Это обеспечивает независимость клиента от хранения данных и улучшает мобильность кода. Серверы не взаимодействуют с интерфейсом пользователя, что упрощает их конструкцию и масштабируемость.
2. Stateless: Сервер не хранит информацию по клиентам. В запросе должна содержаться вся необходимая информация для его обработки и идентификации клиента.
3. Cache: Кэширование ответов обязательно, чтобы предотвратить использование клиентами некорректных данных в будущем.
4. Uniform Interface: Унифицированный интерфейс, обеспечивающий надежную связь между клиентами и серверами, подчеркивается четырьмя ключевыми принципами:

   Эти принципы включают:

   • Ресурсная идентификация: в REST ресурсом считается все, что можно назвать. Каждый ресурс должен иметь стабильный идентификатор, иначе идентификатор, не зависящий от состояния ресурса, выражается URI.
   • Манипуляция ресурсами через представления: Представление позволяет работать с ресурсом, показывая его текущее или желаемое состояние, скажем, в форме XML или HTML.
   • Самодокументируемые сообщения: Все нужные данные содержатся в запросе и ответе, исключая дополнительные сообщения или кэши, важное условие для масштабируемой системы.
   • HATEOAS: Использует гипермедиа для отображения состояния приложения, ссылки в ответе помогают управлять URI и сделают его самоописанием.
5. Layered System: Позволяет деление системы на иерархические слои, где каждый элемент взаимодействует исключительно со следующим близким уровнем.
6. Code-On-Demand (опционально): Возможность загрузки и выполнения кода на клиентской стороне для расширения функциональности.

Это подразумевает, что сервер временно может передать клиенту исполняемую логику или программу для повышения функциональности, например, в виде Java-апплетов или скриптов JavaScript.

Важно: Архитектура REST абстрагирована от конкретных технологий или протоколов, но на практике RESTful API чаще всего использует HTTP с JSON, неизменяемым фаворитом на данном этапе.

Идемпотентность

Под идемпотентностью операции в RESTful-сервисе понимается возможность повторного выполнения одного и того же запроса без изменения результата на сервере. То есть, многократные идентичные запросы эквивалентны одному. Обратите внимание, что хотя идемпотентные операции имеют один и тот же результат на сервере, ответы могут различаться, например, если состояние ресурса изменилось между запросами.

Методы PUT и DELETE по умолчанию считаются идемпотентными. Однако будьте внимательны с методом DELETE, так как успешный запрос DELETE вернет статус 200 (OK) или 204 (No Content), но при последующих обращениях будет возвращен статус 404 (Not Found). Хотя состояние на сервере будет оставаться неизменным, ответы могут различаться.

Методы GET, HEAD, OPTIONS и TRACE определены как безопасные. Эти методы предназначены исключительно для получения информации, не изменяют состояние сервера и не вызывают побочных эффектов, кроме безвредных, таких как: ведение логов, кеширование, показ баннерной рекламы или увеличение счётчиков.

Безопасные операции считаются автоматически идемпотентными, так как не модифицируют серверное состояние. Следует помнить, что безопасность не гарантирует одинаковость возвращаемых результатов при каждом запросе.

HTTP методы для создания RESTful сервисов

HTTP метод GET используется для извлечения или чтения ресурсов. Успешное выполнение запроса GET возвращает ресурс в формате XML или JSON с кодом состояния HTTP 200 (OK). В противном случае могут быть возвращены коды 404 (NOT FOUND) или 400 (BAD REQUEST).

• GET http://www.example.com/api/v1.0/users (получить список пользователей)
• GET http://www.example.com/api/v1.0/users/12345 (получить информацию о пользователе с id 12345)
• GET http://www.example.com/api/v1.0/users/12345/orders (получить список заказов пользователя с id 12345)

HTTP метод PUT чаще всего применяется для обновления ресурса. При отправке PUT-запроса нужно передать обновленные данные ресурса, соответствующего указанному URI.

Для создания ресурсов предпочтительно использовать POST. В этом случае POST предоставляет новому ресурсу соответствующий идентификатор.

Успешный PUT-запрос возвращает код 200 (или 204 при отсутствии содержимого ответа). Несмотря на ненадежность, метод PUT является идемпотентным: повторяющиеся запросы PUT к одному и тому же URI не изменяют общее состояние системы.

• PUT http://www.example.com/api/v1.0/users/12345 (обновить информацию о пользователе с id 12345)
• PUT http://www.example.com/api/v1.0/users/12345/orders/98765 (обновить информацию о заказе с id 98765 для пользователя с id 12345)

HTTP метод POST обычно используется для создания новых ресурсов. Он отправляет данные к родительскому ресурсу, создавая вложенные ресурсы в системе, и при этом сервис отвечает за установление связи с родительским ресурсом и назначение нового ID.

При успешном создании возвращается код HTTP 201, а в заголовке `Location` указывается адрес созданного ресурса.

POST не гарантирует идемпотентности и является небезопасным. Следовательно, его используют для неидемпотентных операций.

• POST http://www.example.com/api/v1.0/customers (создать новый ресурс в разделе customers)
• POST http://www.example.com/api/v1.0/customers/12345/orders (создать заказ для ресурса с id 12345)

HTTP метод DELETE предназначен для удаления ресурсов, идентифицируемых указанным URI (ID).

Успешное выполнение запроса DELETE возвращает код HTTP 200 (OK) с данными удаленного ресурса или 204 (NO CONTENT) без тела ответа. Хотя DELETE считается идемпотентным методом в спецификации HTTP, повторный запрос может вернуть 404 (NOT FOUND), если ресурс уже удален, что не изменяет состояние сервера, но отличаются ответы.

• DELETE http://www.example.com/api/v1.0/customers/12345 (удалить из customers ресурс с id 12345)
• DELETE http://www.example.com/api/v1.0/customers/12345/orders/21 (удалить у ресурса с id 12345 заказ с id 21)

Коды состояния HTTP

Код состояния HTTP отражает, был ли запрос обработан успешно. Коды делятся на пять основных категорий:

1. Информационные 100 - 199
2. Успешные 200 - 299
3. Перенаправления 300 - 399
4. Клиентские ошибки 400 - 499
5. Серверные ошибки 500 - 599

Эти коды подробно описаны в 10-й секции RFC 2616. Обновленная спецификация представлена в RFC 7231.

Если вы столкнулись с не указанным в списке кодом состояния, он, скорее всего, является нестандартизированным или пользовательским.

В таблице ниже перечислены коды состояния HTTP и их значение: