思否開源項目推介丨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 - 思否開源項目支持計劃」，咱們但願藉助社區的資源對開源項目進行相關的宣傳推廣，並做爲一個長期項目助力開源事業的發展，與廣大開發者共建開源新生態。

有意向的開源項目負責人或團隊成員，可經過郵箱提供相應的信息（開源項目地址、項目介紹、團隊介紹、聯繫方式等），以便提高交流的效率。

聯繫郵箱：pr@segmentfault.com