思否开源项目推介丨Knife4j：Java MVC 框架集成 Swagger 生成 API 文档的增强工具

开源项目名称：Knife4j
开源项目负责人：@八一菜刀
开源项目简介：Java MVC 框架集成 Swagger 生成 API 文档的增强工具
开源项目类型：个人开源项目
GitHub 数据：2.6K Star，627 Fork
地址：https://gitee.com/xiaoym/knife4j

项目介绍

在微服务架构盛行的今天，通过集成 Swagger 生成标准的 RESTful API 文档，knife4j 通过与 Swagger 的深度结合，为开发者赋能，降本增效。

knife4j 目前主要提供的功能模块包括四个方面：

1. knife4j-spring：结合 Springfox-swagger 项目，提供增强注解及增强功能，为 Spring 的开发者提高接口对接体验；
2. knife4j-admin：云端 Swagger 注册管理中心，提供自动注册的机制，通过云端将 Swagger 资源综合管理起来，并且提供版本机制，通过 gateway 网关任意组合各种不同的微服务文档，并且给页面加权，让接口文档更加灵活方便
3. knife4j-vue：提供非 Java 语言开发的静态 UI 版本，Python、.net等语言也可以方便使用
4. knife4j-service：将现有的 Swagger 资源提供一些列的在线接口服务程序，譬如 PDF、WORD、HTML 静态文档导出
5. knife4j-extension：为了方便开发者快速调试预览 Swagger 文档而开发的 Chrome 浏览器扩展程序

增强型 SwaggerUI，提供了更多增强功能，给开发者提供一份简洁而不简单的 API 文档。

项目自荐

区别于原 swagger-ui，它主要包含的特点：

• 左右菜单式的文档风格展示列表，接口文档更加简洁，同时具备接口文档说明及在线调试的功能
• 接口参数缓存，方便开发者进行接口联调测试，大大提升工作效率
• 提供接口排序的功能，接口 Setup 化流程操作，接口对接效率提升
• 提供导出 Markdown 格式的文档，可以快速进行静态部署或文档备份，接口说明
• 提供静态部署接口的解决方案，整合适配当前流行的微服务架构，聚合微服务文档输出
• i18n国际化支持，目前支持中文、英文
• 自定义文档功能，开发者可自定义文档，同时在 Swagger 的接口文档中展示，弥补接口文档仅仅展示当前 RESTful API 文档的不足，大大丰富的了接口文档的内容。

思否推荐

写接口“容易”，写接口文档“难”，“难”在没有一个可以提升写接口文档的趁手工具，“难”在写完之后对 API 各种特性进行一个整合。比如对文档的注解、PDF文档导出、接口联调测试等。

Knife4j 作为Java MVC 框架集成 Swagger 生成 API 文档的增强工具，不仅在界面上做了左右菜单式的文档风格等优化，提供了提供增强注解、云端管理 Swagger 资源且提供版本机制、支持 PDF、WORD、HTML 静态文档导出，极大的方便 Java 程序员书写 API。

该项目已入选「SFOSSP - 思否开源项目支持计划」，我们希望借助社区的资源对开源项目进行相关的宣传推广，并作为一个长期项目助力开源事业的发展，与广大开发者共建开源新生态。

有意向的开源项目负责人或团队成员，可通过邮箱提供相应的信息（开源项目地址、项目介绍、团队介绍、联系方式等），以便提升交流的效率。

联系邮箱：[e-mail]