微服务网关整合 Knife4j

微服务网关整合Knife4j

微服务架构下，每个服务都有自己的接口文档，但是需要访问不同的地址。如果想通过网关作为统一入口将所有文档聚合在一起，就需要使用 knife4j 提供的网关进行聚合组件。

knife4j 官网

系统版本

• JDK 17
• Spring Boot 3.0.2
• Spring Cloud 2022.0.0

项目准备
微服务实战项目 —— 知识分享应用（一）
微服务实战项目 —— 知识分享应用（二）
微服务实战项目 —— 知识分享应用（三）

业务模块

1. 添加依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>4.3.0</version>
</dependency>

2. 写配置

knife4j:
  enable: true
  setting:
    language: zh_cn
springdoc:
  api-docs:
    # 文档地址
    path: /v3/api-docs
  group-configs:
    - group: default
      # 改成自己的包名
      packages-to-scan: xxxxx
      paths-to-match: /**
  swagger-ui:
    operations-sorter: alpha
    path: /swagger-ui.html
    tags-sorter: alpha

3. Controller层和一些实体类可以添加一些注解，让接口文档看起来更加友好

单体服务测试

重启服务后，访问 http://${ip}:${port}/doc.html 查看单体服务的 knife4j 能否正常运行。

网关模块

1. 依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-gateway-spring-boot-starter</artifactId>
    <version>4.3.0</version>
</dependency>

2. 配置

knife4j:
  gateway:
    # 开启网关聚合文档
    enabled: true
    # 服务发现
    discover:
      # 开启服务发现 默认:true
      enabled: true
      # 排除的服务名 默认:为空 (建议排除网关服务)
      excluded-services: gateway-service
    routes:
     	# 服务名称
      - name: user-server
        # 文档地址，查看单体服务中的文档地址，并且加上前缀，并且注意分组
        url: /user-service/v3/api-docs?group=default
        # 上下文前缀，看 spring.cloud.gateway.routes 中每个服务的 predicates.Path 里写的前缀
        context-path: /user-service
        # 服务名
        service-name: user-service
        # 排序
        order: 1
        # 其他服务同样配置
      - name: content-server
        url: /content-service/v3/api-docs?group=default
        context-path: /content-service
        service-name: content-service
        order: 2

3. 放行文档接口

在网关模块中，添加访问文档的白名单。例如

聚合文档测试

访问 http://${网关ip}:${网关端口}/doc.html , 查看是否能够正常访问。