java - 来自现有 JSON 的 Springfox Swagger Ui

Question

我有一个 gradle 支持 SpringBoot 我们最初只是创建 REST Controller 然后使用 的应用程序@EnableSwagger2 注释来创建我们的招摇 UI。这工作得很好，但现在我们想要过渡到 API 优先方法。

所以这意味着我们现在正在创建我们的 swagger.json首先，然后使用 swagger-codegen生成我们的 Java 接口(interface)/ Controller 以在我们的 SpringBoot 应用程序中使用。我现在正试图弄清楚如何告诉 springfox-swagger-ui使用 swagger.json我们已经创建了，而不是在事后查看 java 代码来生成 UI。在我看来，这是正确的方法，以避免本质上可能引起的任何不一致 springfox-swagger-ui从重新生成 swagger.json在幕后。

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

Answer 1

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

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

/swagger-resources返回一个 JSON 字符串表示的端点springfox.documentation.swagger.web.SwaggerResource目的。

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

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

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