是否可以使用带有Swagger / SpringFox的spring-auto-restdocs?

时间:2018-05-28 17:02:31

标签: swagger swagger-ui swagger-2.0 springfox spring-auto-restdocs

是否可以在Swagger / SpringFox中使用spring-auto-restdocs,swagger2markup?

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

1 个答案:

答案 0 :(得分:1)

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

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