api - 记录 Spring HATEOAS API

Question

关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。












想改善这个问题吗？更新问题，使其成为 on-topic对于堆栈溢出。

3年前关闭。




Improve this question




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

Swagger 界面非常好，但它没有 3 级 REST 支持。

Answer 1

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

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

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

要查看实际结果(尽管这是硬编码的)，请查看:foxycart .单击 rels 旁边的小文档链接。