Spring Cloud Alibaba微服务实战十一 - Swagger接口文档聚合

在Spring Cloud Alibaba微服务实战中，我们通常需要对外提供API接口，并且需要一个清晰、易用的接口文档。Swagger可以帮助我们实现这一需求。以下是一个简化的Swagger配置示例：

@Configuration
public class SwaggerConfig {
 
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("示例微服务API文档")
                .description("这是一个示例微服务的API文档")
                .version("1.0")
                .build();
    }
}

在上述代码中，我们定义了一个配置类SwaggerConfig，并创建了一个Docket Bean。我们指定了API的基本信息，例如标题、描述、版本等，并且通过apis()方法指定了需要生成文档的Controller包路径。这样，Swagger就会扫描指定的包路径下的所有Controller，并生成对应的API文档。

在微服务架构中，通常会有多个服务，每个服务都可以有自己的Swagger配置。为了在微服务网关中聚合这些服务的Swagger文档，可以使用Springfox的swagger-ui和swagger-resources接口。

以下是一个简化的微服务网关中的Swagger配置示例：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
 
    @Autowired
    private RouteLocator routeLocator;
 
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
 
    @Primary
    @Bean
    public SwaggerResourcesProvider swaggerResourcesProvider(
            InMemoryResourceProvider inMemoryResourceProvider) {
        return () -> {
            List<SwaggerResource> resources = new ArrayList<>();
            List<Route> routes = routeLocator.getRoutes();
 
            // 遍历所有路由
            routes.forEach(route -> {
                // 过滤出需要显示Swagger的服务
                if (route.getId().startsWith("service-provider")) {
                    String name = route.getId();
                    String location = route.getUri().toString() + "/v2/api-docs";
                    resources.add(new SwaggerResource(name, location, "/swagger-resources/configuration/ui"));
                }
            });
 
            return resources;
        };
    }
}

在上述代码中，我们定义了一个配置类SwaggerConfig，并创建了一个Docket Bean。我们使用@EnableSwagger2注解启用Swagger。在\`swagg