记录Spring HATEOAS API

Question

是否有任何插件（类似于Swagger）提供了记录HATEOAS API的能力？

Swagger界面相当不错，但它没有3级REST支持。

Answer 1

我将spring-restdocs与HAL浏览器结合使用。

尽管建议使用，但您不一定需要HAL用于restdocs。

Restdocs将生成代码示例并链接＆amp; asciidoc格式的字段描述符。然后，您可以从HAL浏览器中链接到这些asciidoc。

要查看结果（虽然这是硬编码的），请查看以下内容：foxycart。单击rels旁边的小文档链接。

Answer 2

经过进一步调查后，我发现HAL浏览器（https://github.com/mikekelly/hal-browser）非常好。虽然，您的API必须为其返回内容类型的HAL。

您不需要在服务器上为此工具配置任何内容。只需在浏览器中打开它并指向您的API。