2024年最新Knife4j实现微服务聚合API文档实战

注意的是，这边location必须使用如下图所示的内容，否则无法识别，会报异常

微服务聚合模式

微服务聚合方式分为Disk、Cloud、Eureka、Nacos四种模式，只是配置不同，都很简单

Disk本地模式

开发者只需要在Spring Boot的项目中存在OpenAPI规范的JSON文件即可进行聚合

配置yml配置文件如下：

server:
  port: 9090
knife4j:
  enableAggregation: true
  disk:
    enable: true
    routes:
      - name: 用户
        location: classpath:openapi/user.json

配置目录如下：

启动后效果如下：

Cloud模式聚合

Cloud(云端)模式和Disk模式大同小异，主要的区别是获取OpenAPI规范的方式换成了基于HTTP接口而已

配置yml配置文件如下：

# knife4j配置
knife4j:
  # 开启聚合
  enableAggregation: true
  # Cloud模式
  cloud:
  	# 开启
    enable: true
    # 路由配置
    routes:
      - name: easypoi测试
        uri: localhost:8001
        location: /v2/api-docs?group=WEB接口文档1.0版本
      - name: kafka测试
        uri: localhost:8002
        location: /v2/api-docs?group=WEB接口文档1.0版本

Eureka注册中心聚合

从Eureka注册中心进行聚合的模式和Cloud模式大同小异，主要的区别是通过serviceName来替代了真实的目标服务地

knife4j:
  enableAggregation: true
  eureka:
    enable: true
    serviceUrl: http://localhost:10000/eureka/
    routes:
      - name: easypoi测试
        serviceName: service-easypoi
        location: /v2/api-docs?group=WEB接口文档1.0版本
        servicePath: /easypoi
      - name: kafka测试
        serviceName: service-kafka
        location: /v2/api-docs?group=WEB接口文档1.0版本
        servicePath: /kafka

Nacos注册中心聚合

Nacos的配置和Eureka几乎一模一样，唯一不同的区别是在yml进行配置的时候，使用的是knife4j.nacos开头，其他基本都是一样。

knife4j:
  enableAggregation: true
  nacos:
    enable: true
    serviceUrl: http://localhost:8848/
    routes:
      - name: easypoi测试
        serviceName: service-easypoi
        location: /v2/api-docs?group=WEB接口文档1.0版本
        servicePath: /easypoi
      - name: kafka测试
        serviceName: service-kafka
        location: /v2/api-docs?group=WEB接口文档1.0版本
        servicePath: /kafka

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

😕/bbs.csdn.net/topics/618545628)**

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！