這些年我用過的 API 文檔工具，個個是精品！
這些年用過不少API文檔工具，也寫過不少相關(guān)的文章，我發(fā)現(xiàn)
哪種API文檔工具更好用一直都是大家比較關(guān)心的話題。今天整理了下我曾經(jīng)用過的7種API文檔工具，每個都有詳細(xì)的使用教程，肯定有你中意的一種！
Swagger
Swagger是一款非常流行的API文檔工具，它能幫助你簡化API文檔的開發(fā)，極大提高開發(fā)效率，之前在mall項(xiàng)目中就是使用的它。
我們一般將Swagger和SpringBoot結(jié)合使用，使用的是Springfox給我們提供的工具。使用該工具可以根據(jù)注解自動生成API文檔，并且可以在生成的文檔上進(jìn)行接口調(diào)試。
由于API文檔隨著項(xiàng)目的啟動而更新，所以API文檔的實(shí)時性很有保證！Springfox官方還給我們提供了Starter，整合非常方便。
項(xiàng)目地址：https://github.com/springfox/springfox
Knife4j
雖然Swagger已經(jīng)非常好用，但是存在界面不夠美觀，API調(diào)試功能弱的缺點(diǎn)，比如請求參數(shù)沒有校驗(yàn)，返回一堆JSON數(shù)據(jù)時無法折疊這類問題。于是在Swagger的基礎(chǔ)上，就有了一些增強(qiáng)工具的出現(xiàn)。
Knife4j是springfox-swagger的增強(qiáng)UI實(shí)現(xiàn)，為Java開發(fā)者在使用Swagger的時候，提供了簡潔、強(qiáng)大的接口文檔體驗(yàn)。Knife4j完全遵循了springfox-swagger中的使用方式，并在此基礎(chǔ)上做了增強(qiáng)功能，如果你用過Swagger，你就可以無縫切換到Knife4j。
使用Knife4j就好像給Swagger換了個新皮膚，瞬間就高大上了。
如果你的項(xiàng)目是微服務(wù)項(xiàng)目的話，使用Knife4j可以聚合所有服務(wù)的文檔。
項(xiàng)目地址：https://github.com/xiaoymin/swagger-bootstrap-ui
Postman
由于Swagger的接口調(diào)試能力比較弱，使用Postman來調(diào)試也不失為一個好方案。
Postman是一款A(yù)PI接口調(diào)試工具，使用它可以很方便的對接口進(jìn)行測試，并且后端人員可以將自己的調(diào)試結(jié)果導(dǎo)出，方便前端人員調(diào)試。
當(dāng)然在Postman中查看API文檔也是可以的，只是功能有點(diǎn)偏弱，所以才有了Swagger+Postman這種流行組合。
官方網(wǎng)站：https://www.postman.com/
YApi
除了Knife4j這類給Swagger做增強(qiáng)的工具，還有一類工具本身就具有API文檔管理的功能，可獨(dú)立部署并且可以對接Swagger，功能更加強(qiáng)大，也可以稱之為API文檔管理平臺。
YApi正是這樣一種工具，YApi是高效、易用、功能強(qiáng)大的API管理平臺，旨在為開發(fā)、產(chǎn)品、測試人員提供更優(yōu)雅的接口管理服務(wù)。YApi在Github上已累計獲得了18K+Star，具有優(yōu)秀的交互體驗(yàn)，YApi不僅提供了常用的接口管理功能，還提供了權(quán)限管理、Mock數(shù)據(jù)、Swagger數(shù)據(jù)導(dǎo)入等功能，總之功能很強(qiáng)大！
項(xiàng)目地址：https://github.com/YMFE/yapi
smart-doc
Swagger需要通過它自己的注解來實(shí)現(xiàn)API文檔的生成，代碼入侵性有點(diǎn)強(qiáng)，如果你想零入侵的話，不妨試試smart-doc。
smart-doc是一款A(yù)PI文檔生成工具，無需多余操作，只要你規(guī)范地寫好代碼注釋，就能生成API文檔。同時能直接生成Postman調(diào)試文件，一鍵導(dǎo)入Postman即可調(diào)試，非常好用！
smart-doc和Swagger的接口調(diào)試能力一樣，都比較弱，也得配合Postman來使用?。
項(xiàng)目地址：https://gitee.com/smart-doc-team/smart-doc
Torna
又一款可獨(dú)立部署的API文檔管理工具，可以搭建API文檔管理平臺。不僅支持Swagger導(dǎo)入、還支持Postman和OpenApi等導(dǎo)入。
Torna是一套企業(yè)級接口文檔解決方案，可以配合Swagger使用?。它具有如下功能：
文檔管理：支持接口文檔增刪改查、接口調(diào)試、字典管理及導(dǎo)入導(dǎo)出功能； 權(quán)限管理：支持接口文檔的權(quán)限管理，同時有訪客、開發(fā)者、管理員三種角色； 雙模式：獨(dú)創(chuàng)的雙模式，管理模式可以用來編輯文檔內(nèi)容，瀏覽模式純粹查閱文檔，界面無其它元素干擾。
項(xiàng)目地址：https://gitee.com/durcframework/torna
Apifox
一款在線使用的API文檔管理工具，可以配合Swagger使用，功能強(qiáng)大，界面炫酷！
Apifox 的定位是Postman + Swagger + Mock + JMeter，具有API文檔管理、API調(diào)試、API Mock、API 自動化測試等功能?？梢酝ㄟ^一種工具解決之前使用多種工具的數(shù)據(jù)同步問題。高效、及時、準(zhǔn)確！
官方網(wǎng)站：https://www.apifox.cn/
總結(jié)
本文整理了之前使用過的7種API文檔生成+管理工具，如果你是剛開始使用API文檔工具的話，使用Swagger準(zhǔn)沒錯！如果你正在使用Swagger，想要使用更好的API文檔工具的話，可以考慮將Swagger配合Knife4j、YApi或Torna來使用。如果你不介意在線使用API文檔管理工具的話，可以使用Apifox，它的功能更強(qiáng)大。
我是小富～，如果對你有用在看、關(guān)注支持下，咱們下期見~
?往期推薦?
??
面試官問：訂單30分鐘未支付，自動取消，該怎么實(shí)現(xiàn)？
11 張圖總結(jié)下，微服務(wù)增量拉取
給你一個億的keys，Redis如何統(tǒng)計？
在看、點(diǎn)贊、轉(zhuǎn)發(fā)，是對我最大的鼓勵。
整理了幾百本各類技術(shù)電子書，有需要的同學(xué)公眾號內(nèi)回復(fù)[?666?]自取。技術(shù)群快滿了，想進(jìn)的同學(xué)可以加我好友，和大佬們一起吹吹技術(shù)。
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?你的每個贊和在看，我都喜歡！
