保持 doc.html 使用习惯
Maven groupId 切到 com.baizhukui 即可替换原依赖,/doc.html、/v2/api-docs、/v3/api-docs 入口保持不变。
迁移指引
延续熟悉的 doc.html 接入方式,持续修复 Spring Boot 2.7 / 3.x / 4.x 的兼容性。这是 Knife4j 的社区维护 fork。
knife4j-next 是 xiaoymin/knife4j 的社区维护分支。
com.github.xiaoymin.knife4j.* Java 包名,不做重命名。doc.html / v2/api-docs / v3/api-docs 访问入口。@ApiOperationSupport、@ApiSupport、knife4j.* 等全部既有注解与配置键。groupId:com.github.xiaoymin → com.baizhukui,其余业务代码不用动。Spring Boot 3.x(Jakarta):
<dependency>
<groupId>com.baizhukui</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>5.0.8</version>
</dependency>最小配置(使用 springdoc 默认 /v3/api-docs 和 /swagger-ui.html):
knife4j:
enable: trueknife4j.setting.language 默认就是 zh_cn;springdoc.swagger-ui.path 和 springdoc.api-docs.path 也沿用 springdoc 默认值即可。真实项目可按需补充 springdoc.packages-to-scan、paths-to-match 或 swagger-ui.tags-sorter 等扫描与排序配置。
启动应用后访问 http://localhost:8080/doc.html。完整流程见 快速开始。
servicePath 时 swagger-config 返回 500 的问题x-order 排序 tag 与 operation完整更新列表见 发布说明。
关于新前端覆盖范围
新 React 前端当前仅覆盖部分 upstream 增强特性。它会读取部分 knife4j.setting.* UI 默认值,包括自定义 Footer 与后端注入的自定义首页 Markdown;但如果你依赖的是 enable-after-script、enable-version、Postman 导出等 Vue 时代能力,请在切换到新前端前先查阅 新前端覆盖范围。home-custom-path 仍由后端读取,不是前端读取文件的入口。knife4j-openapi2-ui 由本仓库 knife4j-vue3 构建,处于兼容维护状态,upstream 已有特性继续可用。
上手
com.github.xiaoymin 切到 com.baizhukuiknife4j-demo-openapi3(OpenAPI 3)与 knife4j-demo-openapi2(OpenAPI 2)两条线的本地跑 / Docker Compose组件
参考
knife4j.* YAML 选项其他