首页 > 软件列表 > Knife4j
Knife4j

Knife4j

文档服务通用性解决方案

软件语言:简体中文
软件授权:开源
适用系统:Windows
创建时间:2020-12-02
软件厂商/开发者信息:xiaoymin

软件介绍

Knife4j 是一个面向 Java MVC 框架的 API 文档增强方案,把 Swagger2 与 OpenAPI3 两套规范整合在一起。它的前身是 swagger-bootstrap-ui,后来改名为 Knife4j。项目采用 Apache License 2.0 开源,源码托管在 Gitee,官方文档站为 doc.xiaominfo.com。

核心功能

  • 双规范支持:同时支持 OpenAPI 2.0 与 3.0,并为 Springfox(Swagger2)和 Springdoc(OAS3)提供自动配置的 starter。
  • 文档界面:提供自定义文档、动态参数调试、国际化、接口排序和文档导出等功能。
  • 微服务聚合:可以聚合网关和多个微服务的接口文档,并提供 Kubernetes / Docker 部署方式。

支持平台与系统要求

Knife4j 以 Maven 依赖的方式集成到 Java 项目中,官方文档列出的兼容范围是 Spring Boot 2.2 至 2.7 以及 3.0,支持 Spring MVC 与 Spring WebFlux。官方文档未明确写出所需的 JDK 版本,使用前请以对应版本的文档为准。它是开发库,没有独立的桌面安装程序。

版本与授权

截至本次核查,GitHub 发布页标记的最新版本为 4.5.0,更新内容包括增加日语国际化支持,以及修复 Spring Boot 3 下的排序问题和 @Schema 描述显示问题。站内收录的 2.0.8 属于较早的版本。

适用人群

适合使用 Spring Boot 或 Spring Cloud 开发后端接口的 Java 团队,用来生成、浏览和调试接口文档,或在微服务架构下集中展示各服务的文档。

版本列表