Skip to content

功能

Knife4j Next 围绕“文档更清晰、调试更顺手、聚合更简单、交付更完整”四个方向,提供面向 Spring 生态的 OpenAPI 文档增强能力。

核心功能

API 文档浏览

  • 提供更清晰的接口分组、参数说明和模型结构展示。
  • 让大型项目里的接口更容易被查找、理解和复用。

在线接口调试

  • 支持直接在文档页面内发起请求。
  • 覆盖常见鉴权、全局参数和请求调试场景。

微服务文档聚合

  • 面向 Spring Cloud Gateway 和多服务项目提供统一的文档入口。
  • 适合按分组、按服务汇总 OpenAPI 文档。

离线文档导出

  • 支持团队评审、归档和交付所需的离线文档能力。
  • 方便将接口说明带出运行环境单独分发。

主要能力

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

适合哪些场景

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

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

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