作为开发人员,我更喜欢spring restdocs。但作为文档的使用者,我发现swagger实时文档非常引人注目。这是无处不在的例子:http://petstore.swagger.io/
有没有办法用spring restdocs记录我的其他api但是生成像swagger petstore这样的实时文档?如果是这样,你怎么做?
答案 0 :(得分:7)
不,它不可能开箱即用。 REST Docs旨在是可扩展的,因此您可以自己添加功能,但这将是一项重大任务。
我是REST Docs项目的负责人,对实时文档的支持很有意义,但目前并不是特别重要。根据我的经验,实时文档可以作为游乐场使用,但实际记录服务的工作很差。我目前的重点是制作准确且结构良好的文档。如果你正在寻找比Asciidoctor的空白画布更具指导性的东西,那么使用带有Slate的REST Docs可以为你提供一个大的快速启动。