SpringBoot中使用Swagger.yaml的Swagger UI

Question

我们有一个SpringBoot（版本1.5.12)REST Api，带有springfox-swagger2和springfox-swagger-ui（版本2.9.2)

@EnableSwagger2
public class Application extends SpringBootServletInitializer {
   @Bean
   public Docket swagger() {
       return new Docket(SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build();
    }

我可以在http://localhost:8080/swagger-ui.html看到Swagger UI

我如何配置swagger-ui来读取我的swagger.yaml/json配置文件，而不是自动生成它？我尝试了几个配置都没有成功。

Answer 1

您需要创建一个可以提供swaggerResourcesProvider@primarybean的类，该bean如下所示指定配置的位置（考虑到src/main/resources中存在swager.json文件）

@Configuration
public class SwaggerSpecConfig {

    @Primary
    @Bean
    public SwaggerResourcesProvider swaggerResourcesProvider(InMemorySwaggerResourcesProvider defaultResourcesProvider) {
        return () -> {
            SwaggerResource wsResource = new SwaggerResource();
            wsResource.setName("new spec");
            wsResource.setSwaggerVersion("2.0");
            wsResource.setLocation("/swagger.json");

            List<SwaggerResource> resources = new ArrayList<>(defaultResourcesProvider.get());
            resources.add(wsResource);
            return resources;
        };
    }
}

然后在Swagger UI上，您可以从json中选择规范（这里名为new spec)，如下所示：

以下是指向Springfox文档的链接:http://Springfox.github.io/Springfox/docs/current/#aggregating-multiple-swagger-specifications-in-the-same-swagger-UI