自動生成接口文檔的三種方式

開始

作開發常常會碰到這樣的狀況，前期寫了接口文檔，後端把需求改完沒時間更新接口文檔，想一想就以爲崩潰了。那麼有沒有方法能自動生成接口文檔來提升先後端的開發效率呢？

自定義動態生成接口文檔，手動部署

在對外暴露的接口上添加一套自定義註解。註解可指定接口名稱，請求 url，請求方式，請求參數，請求參數類型，返回參數，返回參數類型等信息。經過解析 controller 類上註解和方法上的註解，生成獲取全部對外暴露方法的定義的接口，而後經過 web 頁面呈現全部接口定義。

項目組全部人使用Swagger，統一標準

項目集成 Swagger 插件，添加Swagger依賴，前端人員訪問 Swagger 生成的接口文檔，查看和使用接口。

使用Eolinker，根據需求導出不一樣格式接口文檔

後端開發直接將項目導入到Eolinker，完善需求時會自動生成接口代碼，導入和導出均支持多種格式，通用性較高。
使用地址：www.eolinker.com

最後

本文的思考來源於工做。項目接口文檔本應該就是根據代碼同時發佈的，在多加一步操做，將生成的接口文檔自動部署到服務上，就實現接口文檔的自動更新，一勞永逸！