Hypermedia as the Engine of Application State

Рассмотрим специфичный архитектурный принцип проектирования API, набирающий популярность на данный момент, — HATEOAS (Hypermedia as the Engine of Application State).

HATEOAS можно рассматривать как продолжение архитектурных принципов REST, а точнее, как некоторое его ограничение. Данный принцип встречается далеко не только в Java-приложениях, написанных со Spring, но и в PHP-приложениях, где HATEOAS является неотъемлемой частью некоторых фреймворков.

Самым простым образом HATEOAS можно описать так:

«Web-сервисы тоже люди и они тоже хотят ходить по ссылкам, как ходят настоящие люди по страницам, используя HTTP/HTML»

Т.е. своего рода гипертекст для REST-клиентов. Разберёмся подробнее. Если бы мы рассматривали классический веб-сервис работы, например, со студентами, то выглядел бы он примерно таким образом:

GET /students/{id} - возвращает JSON конкретного студента
PUT /students/{id}/transfer/{groupId} - перевод студента в другую группу и т.д.
И GET-метод обычно возвращает что-то вроде:
{
  "id": 5,
  "name": "Ivan Ivanov"
}

Чтобы работать с данным веб-сервисом, нам необходимо помнить все URL данных методов. При этом, если какая-то операция недоступна по каким-то причинам (или по бизнес-логике, или с точки зрения прав доступа), мы узнаем об этом только тогда, когда обратимся по данному URL.

Разберёмся, что будет возвращать метод GET, написанный по принципу HATEOAS:

{
  "id": 5,
  "name": "Ivan Ivanov",
  "links": [{
    "rel": "self",
    "href": "http://localhost/students/5"
  }, {
    "rel": "transfer",
    "href": "http://localhost/students/5/transfer"
  }],
}

В данном примере, помимо данных объекта, возвращаются ещё и ссылки, причём с дополнительной информацией. REST-клиент, получив такой ответ, всегда теперь знает: — ссылку на данный объект (self); — операции, которые можно делать с данным объектом; — ссылки по которым эти операции доступны.

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

Но самое главное, теперь можно спокойно менять API !

Действительно, клиенту теперь нет необходимости запоминать заранее методы, он их получит динамически при обращении к ресурсу. Это похоже на открытие страниц сайта — достаточно помнить только главную страницу и просто переходить по ссылке, а как устроен сайт, мы редко запоминаем.

Конечно, проблема «запомнить URL ресурса» осталась, но это уже совсем другая история.

Остались вопросы? Напишите в комментариях!