来自现有 JSON 的 Springfox Swagger Ui

Spa*_*bil 5 java swagger-ui spring-boot springfox swagger-codegen

我有一个 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幕后可能引起的任何不一致。

我该如何配置这种行为?谢谢。

Ind*_*sak 3

下面是一个关于如何从现有的swagger.json.

您需要编写一个具有以下端点的自定义 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 表示形式的端点。