Spring Gateway统一管理Swagger接口

"本文主要介绍如何在gateway网关中实现对swagger的统一管理，通过引入相关依赖、配置过滤器以及定制Swagger资源提供者，达到在网关层展示所有微服务的API文档的目的。" 在微服务架构中，网关通常扮演着统一入口的角色，处理路由转发、认证授权等任务。为了方便开发者对各个微服务的接口进行管理和测试，我们可以利用Swagger来生成和整合API文档。以下是如何在Spring Cloud Gateway中实现gateway网关统一管理swagger的步骤： 1. 引入Swagger依赖 首先，我们需要在项目的pom.xml文件中添加Springfox的Swagger2和Swagger-UI的依赖。这里使用的是版本2.9.2，具体代码如下： ```xml <!-- Swagger依赖 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> ``` 这两个依赖分别用于处理Swagger的API定义和提供用户友好的Web界面。 2. 创建SwaggerHeaderFilter 创建一个自定义过滤器`SwaggerHeaderFilter`，目的是去除URL前缀，以便于在gateway网关上正确地展示Swagger UI。这个过滤器需要注入到Gateway中，以便对请求进行拦截和处理。在过滤器中，我们覆盖了`apply`方法，返回一个过滤器链，保持原有请求不变。 ```java @Component @Slf4j public class SwaggerHeaderFilter extends AbstractGatewayFilterFactory<Object> { @Override public GatewayFilter apply(Object config) { return (exchange, chain) -> chain.filter(exchange); } } ``` 并在网关的路由配置中，使用`SwaggerHeaderFilter`过滤器，例如： ```yaml gateway: routes: - id: oauth2-service uri: lb://ioelin-oauth2-service predicates: - Path=/oauth2/,/oauth/ filters: - SwaggerHeaderFilter # 使用过滤器去除url前缀 - StripPrefix=1 # 要去除的前缀级别，1表示/oauth2/oauth2/user去除后为/oauth2/user ``` 3. 配置SwaggerResourcesProvider 我们需要创建一个自定义的`SwaggerResourcesProvider`，它实现了`SwaggerResourcesProvider`接口，以获取并处理所有微服务的Swagger资源。在该类中，我们可以遍历所有的路由，动态生成每个微服务的Swagger资源配置。 ```java @Component @Primary @Slf4j public class GatewaySwaggerProvider implements SwaggerResourcesProvider { private static final String API_URI = "/v2/api-docs"; private final RouteLocator routeLocator; // 依赖注入 public GatewaySwaggerProvider(RouteLocator routeLocator) { this.routeLocator = routeLocator; } @Override public List<SwaggerResource> get() { // 获取所有路由并生成Swagger资源 return routeLocator.getRoutes().stream() .map(route -> createSwaggerResource(route.getId(), route.getUri().toString())) .collect(Collectors.toList()); } // 创建Swagger资源 private SwaggerResource createSwaggerResource(String name, String location) { SwaggerResource resource = new SwaggerResource(); resource.setName(name); resource.setLocation(API_URI + "?services=" + location); // 这里的location应该是微服务的地址 resource.setVersion("1.0"); // 设置版本号 return resource; } } ``` 通过这种方式，`SwaggerResourcesProvider`会根据网关中的路由信息动态生成Swagger资源，使得Swagger UI可以展示所有微服务的API。 4. 启动并访问Swagger UI 完成以上步骤后，当网关启动，可以通过访问Swagger UI的路径（通常是`/swagger-ui.html`）来查看和测试所有微服务的API。注意，你需要确保每个微服务也已经正确配置了Swagger，并且暴露了对应的API文档。 总结，通过在Spring Cloud Gateway中集成Springfox的Swagger2和Swagger-UI，并自定义过滤器和Swagger资源提供者，我们可以实现网关对所有微服务Swagger的统一管理，使得API文档的维护和测试更加便捷。这有助于提高开发效率，同时也便于API的版本管理和文档分享。