REST API — Что такое HATEOAS?

В этой статье вы продолжите изучать REST API и узнаете о HATEOAS.

При просмотре веб-страницы вы можете просматривать данные на странице и выполнять с ними действия.

Как насчет REST API? Как правило, когда вы запрашиваете REST ресурс, вы получаете информацию о ресурсе обратно. Как насчет отправки операций, которые вы можете сделать с ресурсом в ответе?

Вы изучите:

• Что такое HATEOAS?
• Почему вам нужно использовать HATEOAS?
• Когда использовать HATEOAS?

REST API

Это пятая статья в серии статей про REST API:

• Введение в REST API — RESTful веб-сервисы ^[1]
• Различия REST и SOAP ^[2]
• Разработка REST API — что такое Contract First (контракт в первую очередь)? ^[3]
• Разработка REST API — что такое Code First (код в первую очередь)? ^[4]
• REST API — Что такое HATEOAS?
• Рекомендации по REST API — примеры проектирования веб-сервисов на Java и Spring

Что означает HATEOAS?

Термин HATEOAS означает фразу «Hypermedia As The Engine Of Application State» (Гипермедиа как двигатель состояния приложения). Чтобы понять это глубже, нам сначала нужно понять значение гипермедиа. Взгляните на следующую веб-страницу:

Когда браузер загружает страницу, вы определенно можете увидеть весь контент, который может предложить эта страница. Что еще более интересно, страница также позволяет вам выполнять множество действий с этими данными, например:

• Нажатие на кнопки (зеленое «Clone» (Клонировать) или «Download» (Скачать)
• Нажатие на вкладки (например, для просмотра «Issues» (Проблемы))
• и еще несколько

Теперь давайте посмотрим, как ведут себя наши REST API:

Если вы посмотрите на типичный запрос GET к RESTful серверу, такой как этот:

Запрос GET localhost ^[5]:8080/users получает набор данных трех пользователей в этом случае. Отправив запрос с помощью GET localhost ^[5]:8080/users/1, вы получите сведения только о первом пользователе. Как правило, когда мы выполняем запрос REST, мы получаем только данные, а не какие-либо действия с ними. Вот где HATEOAS восполняет пробел. Запрос HATEOAS позволяет вам не только отправлять данные, но и указывать связанные действия:

Этот пример был в формате JSON. Формат XML для другого примера будет выглядеть примерно так:

Когда вы отправляете этот запрос для получения данных учетной записи, вы получаете оба:

• Номер счета и данные баланса
• Ссылки, которые обеспечивают действия, чтобы сделать депозит/снятие/перевод/закрытие

С HATEOAS запрос на REST ресурс дает мне как данные, так и действия, связанные с данными.

Зачем нам нужен HATEOAS?

Единственная самая важная причина для HATEOAS — слабая связь (loose coupling). Если потребителю службы REST необходимо жестко закодировать все URL-адреса ресурсов, он тесно связан с реализацией вашей службы. Вместо этого, если вы вернете URL-адреса, которые он может использовать для действий, он будет слабосвязанным. Нет строгой зависимости от структуры URI, так как она указана и используется в ответе. Несколько важных тем, связанных с HATEOAS:

HAL — язык гипертекстовых приложений

При разработке службы RESTful необходимо указать, как возвращать данные и ссылки, соответствующие запросу. HAL — это формат, который обеспечивает простой и согласованный способ гиперссылки между ресурсами в вашем REST API. Вот пример:

С HAL у вас есть несколько категорий представлений:

• Links (Ссылки): указано как комбинация
• Target (Цель) — указана в качестве URI
• Relation (Отношение) — имя
• Embedded Resources (Встроенные ресурсы): другие ресурсы, содержащиеся в данном REST ресурсе
• State (Состояние): фактические данные ресурса

Если вам довелось использовать Spring Framework для разработки REST сервиса, то Spring HATEOAS — хороший механизм для вашего сервиса.

По этому вопросу имеется авторское видео ^[6].

Резюме

В этой статье мы рассмотрели, что означает HATEOAS.

С помощью HATEOAS ответы на запросы REST возвращают не только данные, но и действия, которые можно выполнить с ресурсом.

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

Дополнительное чтение

REST + MongoDB + HATEOAS? ^[7]

HATEOAS REST Services With Spring ^[8]

Spring HATEOAS: Hypermedia APIs with Spring ^[9] (добавлено переводчиком)

Автор: val6852

Источник ^[10]