Knife4j资源整合(基于SpringBoot3)

Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案，帮助开发者快速聚合使用OpenAPI规范.

• 适配兼容Spring MVC
• 适配兼容Spring Boot 2.2、2.3、2.4、2.5、2.6、2.7、3.0
• 适配兼容Spring WebFlux
• 基于SpringFox2.x版本提供Swagger2规范的增强扩展
• 基于Springdoc-openapi项目提供OAS3规范的增强扩展

knife4j官网

---

SpringBoot3整合knife4j快速开始

快速开始网上有很多教程，我简单贴上一两个教程，大家可以看看：

• Spring Boot3.0(七)：整合knife4j - 知乎 (zhihu.com)
• SpringBoot3中Swagger整合knife4j和springdoc的配置说明_springdoc openapi knife4j springboot3-CSDN博客
• 快速开始 | Knife4j

大家按照从这几个教程里面挑选一个快速开始构建自己的SpringBoot3项目以及整合knife4j。

OpenAPI规范

另外，knife4j是基于OpenAPI3规范生成接口文档，由Swagger来进行维护，Swagger是为了在前后端分离的时代为后端开发人员提供接口测试以及接口更新的API框架，目前还在更新的是Swagger3，Swagger2已经与于17年停止维护。

见：

swagger：快速入门-CSDN博客

另外，由于knife4j从4.0就开始从SpringFox(用于将Swagger2整合到Spring中)迁移到了SpringDoc(将Swagger3整合到Spring中)项目之上，所以需要对Swagger3的部分特性有所了解：

Swagger3 注解使用（Open API 3）_swagger3注解-CSDN博客

YML配置详解：

springdoc相关配置：

springdoc:
  swagger-ui:
    # swagger-ui路径
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    # API文档基于swagger3
    path: /v3/api-docs
  group-configs:
    # 分组一，default分组
    - group: 'default'
      # 匹配的http路径
      paths-to-match: '/**'
      # 扫描的包
      packages-to-scan: com.zxh
    # 分组二，hello分组
    - group: 'hello'
      paths-to-match: '/hello/**'
      packages-to-scan: com.zxh

 knife4j的相关配置:

3.1 增强模式 | Knife4j​​​​​​​

未完待续......