Skip to content

Knife4j Next更现代的 Knife4j

为 Spring 生态提供开箱即用的 API 文档增强体验,覆盖文档浏览、接口调试、微服务聚合、鉴权配置、离线导出与团队协作。

Knife4j Next

核心功能

BrowseAPI 文档浏览

接口分组、模型结构、参数说明和全文搜索集中展示。

Debug在线接口调试

直接在页面内发起请求,支持常用鉴权和全局参数。

Gateway微服务文档聚合

为网关和多服务项目提供统一的 API 文档入口。

Export离线文档导出

将接口说明导出为团队交付更方便的离线文档。

适合哪些场景

如果你的团队已经在使用 Swagger、OpenAPI、Springfox 或 springdoc-openapi,但默认 UI 不够好用,Knife4j Next 可以作为更完整的文档增强层。

它保留熟悉的 /doc.html 访问入口,同时提供更适合团队协作、联调和微服务聚合的功能。

主要能力

  • 接口分组与搜索:让大型项目中的接口更容易查找、定位和理解。
  • 请求参数增强:支持全局参数、动态参数、参数缓存和请求过滤。
  • 鉴权调试:覆盖 Basic Auth、OAuth2 等常见接口调试场景。
  • 模型展示增强:更友好地展示请求体、响应体和嵌套模型结构。
  • 网关聚合:适合 Spring Cloud Gateway、多服务、多分组的文档统一展示。
  • 离线交付:支持将接口文档导出为离线格式,方便评审、归档和交付。
  • 访问控制:支持生产环境禁用、基础访问控制和文档入口保护。

接入方式

Spring Boot 2.x 和 Spring Boot 3.x 项目都可以通过 starter 快速接入。先从 快速开始 选择适合你的依赖版本,然后启动应用访问:

text
http://ip:port/doc.html

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