swagger - 是否可以将 spring-auto-restdocs 与 Swagger/SpringFox 一起使用？

Question

是否可以将 spring-auto-restdocs 与 Swagger/SpringFox、swagger2markup 一起使用？

我想： - 使用 Swagger/SpringFox 提供测试区域，但是我希望该 UI 中的示例类似于 - spring-restdoc 提供示例代码片段和 - 使用 spring-auto-restdocs从 POJO 获取代表 JSON 对象的文档，只需将 Javadoc 添加到字段而不是招摇注释

Answer 1

我看不到实现这一目标的简单方法。在不使用任何 Swagger 代码（注释或 SpringFox DSL）的情况下，SpringFox 或 swagger2markup 不是很有用。如果您同时拥有 Swagger 注释和 Spring (Auto) REST Docs，则可以将 Spring (Auto) REST Docs 生成的 AsciiDoc 片段包含到用于 swagger2markup 的 AsciiDoc 中。AsciiDoc 支持包含其他 AsciiDoc 文件，并且在将 Spring REST Docs 片段包含到手写文档中时也使用此功能。

我研究了从 REST Docs 片段中生成 Swagger/OpenAPI 文件并编写了有关如何执行此操作的指南https://github.com/fbenz/restdocs-to-swagger但是，它是工具的组合，而不是简单的一体化。此外，字段和方法文档不会进入 Swagger 文件/UI。