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


開始

做開發經常會碰到這樣的情況,前期寫了接口文檔,后端把需求改完沒時間更新接口文檔,想想就覺得崩潰了。那么有沒有方法能自動生成接口文檔來提高前后端的開發效率呢?

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

在對外暴露的接口上添加一套自定義注解。注解可指定接口名稱,請求 url,請求方式,請求參數,請求參數類型,返回參數,返回參數類型等信息。通過解析 controller 類上注解和方法上的注解,生成獲取所有對外暴露方法的定義的接口,然后通過 web 頁面呈現所有接口定義。

項目組所有人使用Swagger,統一標准

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

使用Eolinker,根據需求導出不同格式接口文檔

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

最后

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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM