来自现有JSON的Springfox Swagger Ui

问题描述 投票:1回答:1

我有一个gradle支持的SpringBoot应用程序,我们最初只是创建我们的 REST控制器然后使用@ EnableSwagger2注释创建我们的swagger UI。这工作得很好,但现在我们想要转换到API第一种方法。

所以这意味着我们现在首先创建swagger.json,然后使用swagger-codegen生成我们的Java接口/控制器,以便在我们的SpringBoot应用程序中使用。我现在试图弄清楚如何告诉springfox-swagger-ui使用我们创建的swagger.json,而不是通过java代码查看事后生成UI。在我看来,这是正确的方法,以避免任何可能由于springfox-swagger-ui在幕后重新生成swagger.json而可能产生的不一致。

如何配置此行为?谢谢。

java spring-boot swagger-ui springfox swagger-codegen
1个回答
2
投票

Here是一个关于如何从现有的swagger.json创建Swagger UI的工作示例。

您需要编写具有以下端点的自定义Swagger控制器:

  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表示。
© www.soinside.com 2019 - 2024. All rights reserved.