Skip to content

Knife4j Next更现代的 Knife4j

延续熟悉的 doc.html 接入方式,持续修复 Spring Boot 2.7 / 3.x / 4.x 的兼容性。这是 Knife4j 的社区维护 fork。

Knife4j Next

Knife4x Go v0.7.0

Go 服务现在也能嵌入同一套 React UI,通过标准库 net/http Handler 挂载 UI、加载已有 OpenAPI 3 文档并提供调试控制台。查看 Go 接入

这是 Knife4j 的 fork,不是重写

knife4j-nextxiaoymin/knife4j 的社区维护分支。

  • 保留 com.github.xiaoymin.knife4j.* Java 包名,不做重命名。
  • 保留 doc.html / v2/api-docs / v3/api-docs 访问入口。
  • 保留 @ApiOperationSupport@ApiSupportknife4j.* 等全部既有注解与配置键。
  • 只改 groupIdcom.github.xiaoymincom.baizhukui,其余业务代码不用动。

60 秒上手

默认推荐 Spring Boot 4.x

xml
<dependency>
    <groupId>com.baizhukui</groupId>
    <artifactId>knife4j-openapi3-boot4-spring-boot-starter</artifactId>
    <version>5.6.0</version>
</dependency>

仍在 Spring Boot 3.x 时:

xml
<dependency>
    <groupId>com.baizhukui</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>5.6.0</version>
</dependency>

Spring Boot 2.x / Gateway / 独立聚合等场景,将 artifactId 换成对应 starter,见 快速开始

最小配置(使用 springdoc 默认 /v3/api-docs/swagger-ui.html):

yaml
knife4j:
  enable: true

knife4j.setting.language 默认就是 zh_cnspringdoc.swagger-ui.pathspringdoc.api-docs.path 也沿用 springdoc 默认值即可。真实项目可按需补充 springdoc.packages-to-scanpaths-to-matchswagger-ui.tags-sorter 等扫描与排序配置。

启动应用后访问 http://localhost:8080/doc.html。完整流程见 快速开始

5.6.0 版本亮点 最新

5.6.0 新增浏览器登录会话调试,改善枚举选择与接口目录浏览体验;具体支持范围与浏览器限制见 OpenAPI 3.1 支持与迁移

  • 浏览器会话模式复用登录 Cookie,并保留手填模式与旧缓存行为
  • 枚举下拉框支持输入过滤,接口目录滚动时吸顶当前分组标题
  • Schema 根节点与真实 items 字段使用清晰区分的标签

完整更新列表见 发布说明

关于新前端覆盖范围

新 React 前端当前仅覆盖部分 upstream 增强特性。它会读取部分 knife4j.setting.* UI 默认值,包括自定义 Footer、接口变化提示与后端注入的自定义首页 Markdown;但如果你依赖的是 enable-after-script、Postman 导出等 Vue 时代能力,请在切换到新前端前先查阅 新前端覆盖范围home-custom-path 仍由后端读取,不是前端读取文件的入口。knife4j-openapi2-ui 由本仓库 front/vue3 构建,处于兼容维护状态,upstream 已有特性继续可用。

文档导航

上手

  • 产品介绍:这个 fork 的定位、与 upstream 的对照表
  • 快速开始:Spring Boot 2.x / 3.x / 4.x 完整接入
  • 迁移指引:从 com.github.xiaoymin 切到 com.baizhukui
  • OpenAPI 3.1 支持与迁移:3.1.x 矩阵、JSON Schema 方言、安全边界、迁移示例与有效夹具
  • Demo 预览knife4j-demo-openapi3(OpenAPI 3)与 knife4j-demo-openapi2(OpenAPI 2)两条线的本地跑 / Docker Compose
  • 常见问题:doc.html 404、生产环境禁用、Nginx 反向代理、React 配置不生效

组件

参考

其他

让 OpenAPI 文档更清晰,让接口联调更顺手。