api - 记录Spring HATEOAS API

Closed. This question does not meet Stack Overflow guidelines。它当前不接受答案。












想要改善这个问题吗？更新问题，以便将其作为on-topic用于堆栈溢出。

3年前关闭。



Improve this question




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

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

最佳答案

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

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

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

要查看实际结果(尽管这是硬编码的)，请检查以下内容:foxycart。点击相关文件旁边的小文档链接。