spring restdocs 可以像 swagger 一样生成实时文档吗?
Can spring restdocs generate live documentation like swagger?
作为开发人员,我更喜欢 spring restdocs。但作为文档的使用者,我发现 swagger 实时文档非常引人注目。这是无处不在的例子:http://petstore.swagger.io/
有没有一种方法可以用 spring restdocs 记录我的 rest api,但用它生成像 swagger petstore 这样的实时文档?如果是这样,你是怎么做到的?
不,开箱即用是不可能的。 REST Docs 旨在可扩展,因此您可以自己添加功能,但这将是一项艰巨的任务。
我是 REST Docs 项目的负责人,对实时文档的支持很感兴趣,但目前这不是特别高的优先级。根据我的经验,实时文档可以用作游乐场,但在实际记录服务方面做得很差。我目前的重点是制作准确且结构良好的文档。如果您正在寻找比 Asciidoctor 的空白 canvas.
更具指导意义的内容,那么将 REST Docs 与 Slate 一起使用可以让您在后者上有一个很大的起步。
作为开发人员,我更喜欢 spring restdocs。但作为文档的使用者,我发现 swagger 实时文档非常引人注目。这是无处不在的例子:http://petstore.swagger.io/
有没有一种方法可以用 spring restdocs 记录我的 rest api,但用它生成像 swagger petstore 这样的实时文档?如果是这样,你是怎么做到的?
不,开箱即用是不可能的。 REST Docs 旨在可扩展,因此您可以自己添加功能,但这将是一项艰巨的任务。
我是 REST Docs 项目的负责人,对实时文档的支持很感兴趣,但目前这不是特别高的优先级。根据我的经验,实时文档可以用作游乐场,但在实际记录服务方面做得很差。我目前的重点是制作准确且结构良好的文档。如果您正在寻找比 Asciidoctor 的空白 canvas.
更具指导意义的内容,那么将 REST Docs 与 Slate 一起使用可以让您在后者上有一个很大的起步。