java - spring restdocs 可以生成像 swagger 这样的实时文档吗？

Question

作为开发人员，我更喜欢 spring restdocs。但作为文档的使用者，我发现大张旗鼓的实时文档非常引人注目。这是无处不在的例子： http: //petstore.swagger.io/

有没有办法用spring restdocs记录我的rest apis，但用它生成像swagger petstore这样的实时文档？如果是这样，你如何做到这一点？

Answer 1

不，开箱即用是不可能的。REST Docs 旨在可扩展，因此您可以自己添加功能，但这将是一项重大任务。

我是 REST Docs 项目的负责人，我对实时文档的支持很感兴趣，但目前这并不是特别高的优先级。以我的经验，实时文档作为一个游乐场很有用，但在实际记录服务方面做得很差。我目前的重点是制作准确且结构良好的文档。如果您正在寻找比 Asciidoctor 的空白画布更具指导性的东西，那么将 REST Docs 与 Slate 一起使用可以让您在后者方面有了很大的飞跃。