java - spring restdocs 能否像 swagger 一样生成实时文档?

标签 java spring rest spring-restdocs

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

有没有一种方法可以用 spring restdocs 记录我的 rest api,但用它生成像 swagger petstore 这样的实时文档?如果是这样,您是怎么做到的?

最佳答案

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

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

关于java - spring restdocs 能否像 swagger 一样生成实时文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/36798940/

相关文章:

java - 使用动态文件名将文件从 FtpOutBoundGateway 移动到另一个远程位置

java - 确认传递到 Spring Rest Endpoint 的 RequestBody 的无效输入的方法

rest - 实现 Stripe 后端 - 在本地存储数据或依赖 API 调用的最佳实践?

json - cakephp Web服务如何编写允许我上传文件的 Action

javascript - 如何使用参数 AngularJs onChange 下拉值

java - 如何从 InputStream 读取字节?

java - 文本文件在 Ubuntu 上被覆盖,但在 Windows 中被追加

java - 如何从 JFrame 表单获取输入?

java - 彼此有 2 个本地事务(在不同的数据源上)

java - 以编程方式在 java 类中查找文字