使用Zuul聚合多个微服务的Swagger文档

青旅半醒 2024-03-30 09:54 87阅读 0赞

在 Zuul 中进行聚合操作的原因是不想每次都去访问独立服务的文档，通过网关统一整合这些服务的文档方便使用。

在网关中加入 Swagger 的 Maven 依赖，代码如下所示。

> 1.  `<dependency>`
> 2.  `<groupId>io.springfox</groupId>`
> 3.  `<artifactId>springfox-swagger-ui</artifactId>`
> 4.  `<version>2.9.2</version>`
> 5.  `</dependency>`
> 6.  `<dependency>`
> 7.  `<groupId>io.springfox</groupId>`
> 8.  `<artifactId>springfox-swagger2</artifactId>`
> 9.  `<version>2.9.2</version>`
> 10. `</dependency>`

自定义配置进行整合，笔者采用了一种比较简单的方式，不是手动的去配置要整合的服务信息，而是直接去读取 Eureka 中的服务信息，只要是 Eureka 中的服务就都能整合进来，代码如下所示。

> 1.  `@EnableSwagger2`
> 2.  `@Component`
> 3.  `@Primary`
> 4.  `public class DocumentationConfig implements SwaggerResourcesProvider {`
> 5.  `@Autowired`
> 6.  `private DiscoveryClient discoveryClient;`
> 7.  `@Value("${spring.application.name}")`
> 8.  `private String applicationName;`
> 9.  `@Override`
> 10. `public List<SwaggerResource> get() {`
> 11. `List<SwaggerResource> resources = new ArrayList<>();`
> 12. `// 排除自身, 将其他的服务添加进去`
> 13. `discoveryClient.getServices().stream().filter(s -> !s.equals(applicationName)).forEach(name -> {`
> 14. `resources.add(swaggerResource(name, "/" + name + "/v2/api-docs", "2.0"));`
> 15. `});`
> 16. `return resources;`
> 17. `}`
> 18. `private SwaggerResource swaggerResource(String name, String location, String version) {`
> 19. `SwaggerResource swaggerResource = new SwaggerResource();`
> 20. `swaggerResource.setName(name);`
> 21. `swaggerResource.setLocation(location);`
> 22. `swaggerResource.setSwaggerVersion(version);`
> 23. `return swaggerResource;`
> 24. `}`
> 25. `}`