使用springfox,swagger和gradle生成静态文档

时间:2017-05-18 07:34:20

标签: spring spring-boot swagger springfox

我在一个简单的Spring Boot应用程序中评估了springfox的集成,暴露了一些REST API。乍看之下一切正常 - 当应用程序启动时,我可以在JSON端点看到Swagger规范,我可以连接并使用Swagger UI,Swagger注释被考虑在内,我可以使用代码生成静态HTML文档gen等等等。

我现在想知道的是一件非常简单的事情:如何在构建过程中生成静态文档?我用gradle。在构建期间,服务器显然已关闭,并且swagger规范所在的JSON端点根本不可用...

例如:code base -> build -> (executable jar + documentation + ... )

1 个答案:

答案 0 :(得分:1)

我必须在构建时生成swagger.json个文件,以便在传递Accept标头中的版本时正常使用API​​版本。虽然这样做是使用Maven,但我想它可以帮助你作为一个起点。仅供参考,我使用Spring BootJerseySwagger以及Spring BootCXFSwagger来代替{{1 },Spring MVCSwagger

使用此插件可能也适用于您:

springfox

更多详细信息,请访问:Documenting multiple REST API versions using Spring Boot, Jersey and Swagger