Документирование API Spring HATEOAS

Есть ли там плагины (похожие на Swagger), которые предоставляют возможность документировать API HATEOAS?

Интерфейс Swagger неплохой, но у него нет поддержки REST уровня 3.

Ответ 1

После дальнейшего исследования я обнаружил HAL-браузер (https://github.com/mikekelly/hal-browser), что довольно хорошо. Хотя ваш API должен возвращать для него тип контента HAL.

Вам не нужно настраивать что-либо на сервере для этого инструмента. Просто откройте его в браузере и укажите на свой API.

Ответ 2

Я использую spring-restdocs в сочетании с HAL-браузером.

Вам не обязательно нужен HAL для restdocs, хотя это рекомендуется.

Restdocs будет генерировать образцы кода и ссылки и дескрипторы полей в формате asciidoc. Затем вы можете ссылаться на эти asciidocs внутри HAL-браузера.

Чтобы увидеть результат в действии (хотя это жестко запрограммировано), проверьте это: foxycart. Нажмите на маленькие ссылки doc рядом с rels.