记录 Spring HATEOAS API

Documenting a Spring HATEOAS API

是否有任何插件(类似于 Swagger)提供记录 HATEOAS API 的能力?

Swagger 界面非常好,但它不支持 3 级 REST。

经过进一步调查,我发现 HAL-browser (https://github.com/mikekelly/hal-browser) 非常好。虽然,您的 API 必须 return HAL 的内容类型。

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

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

虽然我们建议您使用 restdocs,但您不一定需要 HAL。

Restdocs 将生成 asciidoc 格式的代码示例和 link & 字段描述符。然后,您可以 link 从 HAL 浏览器内部访问这些 asciidocs。

要查看实际结果(尽管这是硬编码的),请查看:foxycart。单击 rels.

旁边的小文档 links