从JSON生成Swagger以保持我的.java类的清洁

时间:2017-11-22 16:37:48

标签: json spring-boot documentation swagger springfox

我正在使用Springfox v 2.7,我想从JSON文件生成我的Swagger UI,以保持我的Controller类干净,并且没有来自Swawgger(@ Api,@ AbsDocs)的注释我的模型类没有任何注释(@ApiModelProperty等)....

问候!

PD:这是一个Spring boot 1.5.8版App。

1 个答案:

答案 0 :(得分:3)

以下是您需要进行的更改:

  • 只需要Springfox JAR是springfox-swagger-ui JAR,其中包含所有静态UI工件。

  • 包含位于swagger.json文件夹下的所有JSON定义的resources文件。

  • 具有以下端点的自定义控制器,以满足swagger-ui.html的所有请求:

    1. /swagger-resources端点,返回springfox.documentation.swagger.web.SwaggerResource对象的JSON字符串表示。

    2. /swagger-resources/configuration/ui端点,返回springfox.documentation.swagger.web.UiConfiguration对象的JSON字符串表示。

    3. /swagger-resources/configuration/security端点,返回springfox.documentation.swagger.web.SecurityConfiguration对象的JSON字符串表示。

    4. /v2/api-docs端点,它返回Swagger API定义的JSON表示。

您可以找到一个有效的示例here