Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案

https://doc.xiaominfo.com/

该网站也可作为学习微服务的一个参考站点。

基础特性

• 兼容OpenAPI 2.0
• 兼容OpenAPI 3.0

增强扩展

• 基础ui组件(自定义文档、动态参数调试、I18n、接口排序、导出等)
• 基于Springfox框架+Swagger2规范的自动注入starter
• 基于Springdoc-openapi+OAS3规范的自动注入starter
• 提供对主流网关组件的统一聚合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规范的增强扩展

社区生态

• 基于Servlet体系的微服务聚合中间件Knife4jAggregation
• 基于Spring Cloud Gateway网关聚合的微服务聚合中间件
• 独立运行的中间件Knife4jDesktop

云原生

• 提供基于K8S+Docker的云原生的聚合OpenAPI文档的解决方案
• 简化Knife4j的使用及学习成本，一键部署&集成&使用

架构图

使用说明

如果使用springboot 3.3.x请用下面的方式集成

<!-- 只用 springdoc 核心 + Knife4j UI --> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.6.0</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-openapi3-ui</artifactId> <version>4.5.0</version> </dependency>