Spring cloud Gateway 基于使用Netty
作为内嵌服务器,而Netty
基于WebFlux
实现,因此如果想要springdoc
的 Swagger UI 显示在网关微服务中,需要用到它的WebFlux UI
库。
现有三个微服务项目,分别是gateway-service
、shop-service
、user-service
,各依赖库版本如下:
依赖 | 版本 |
---|---|
spring boot | 2.6.1 |
spring cloud | 2021.0.0 |
spring cloud alibaba | 2021.1 |
springdoc openapi | 1.5.13 |
由于只在gateway-service
网关微服务上查看 Swagger UI 页面,因此另外两个业务微服务中只需要添加springdoc openapi
的核心依赖库即可:
...
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webmvc-core</artifactId>
<version>${springdoc.version}</version>
</dependency>
...
而gateway-service
中除了spring cloud gateway
之外,还需要添加springdoc openapi webflux
依赖:
...
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!-- spring cloud 2020之后的版本中不再自动引入Ribbon依赖,需要手动引入loadbalancer 否则会出现503错误 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webflux-ui</artifactId