最近負(fù)責(zé)的一個項目，需要提供一些接口給第三方平臺。但之前的接口文檔沒有或者文檔散落在不同的wiki上。導(dǎo)致需要花費一些額外的工作時間來進(jìn)行接口文檔編寫！

為了減少后期有可能出現(xiàn)的接口文檔，我推薦使用YAPI。

?https://hellosean1025.github.io/yapi/

yapi支持多種格式文檔的導(dǎo)出，也支持特定接口的導(dǎo)出（將特定的接口設(shè)置為公開接口）

支持多種格式文檔的導(dǎo)出

支持部分接口的導(dǎo)出

同時，idea有相關(guān)插件，方便開發(fā)人員將接口直接一鍵同步到y(tǒng)api。

搜索插件：Idea YApi，進(jìn)行安裝

idea插件

以JSON格式配置項目

選擇方法（類），右鍵選擇Idea Yapi即可完成接口文檔的同步

接口同步示例

接口定義

接口注釋需要體現(xiàn)出對應(yīng)的模塊。如：資產(chǎn)管理-數(shù)據(jù)源管理-數(shù)據(jù)源配置。取最后一個數(shù)據(jù)源配置即可，便于接口查找

接口代碼

最終同步效果為：