Api Generator
前言
公司里推廣使用yapi是好幾個月之前的事情了，今天發現了一個好用的插件
可以通過控制層介面直接生成yapi檔案，免去了手寫yapi介面的煩惱
開始
這里直接貼圖介紹最快速的配置程序
后續我會貼上git地址，里面對于配置的介紹更詳細
- step1：打開idea插件庫搜索Api Generator，并下載
-
step2：完成后點擊settings左下角的Other Settings，按步驟點擊
-
step3: 進入到這個頁面
第一欄YApi server url，輸入yapi地址或者yapi部署的地址，圖示我輸入了
https://yapi.linshang.com/
其他引數看下面的步驟
- step4: 打開你的yapi，當前正在撰寫的專案，比如我現在在寫鄰商裝修，就打開鄰商裝修專案
- step5：進入當前專案后，點擊上方的設定，從彈出的選項卡中選擇token設定，并復制token值
-
step 6:將token復制到插件中，并設定你將要新增的介面的檔案夾名
這里我使用默認的檔案夾名api_generator 并應用
下方還有一個單選框，勾選該選項后，生成檔案時插件將從controller類注釋里抽取模塊名，并在yapi上自動創建對應分類保存介面
- step 7: 在控制層介面的方法簽名中右鍵，并點擊generate api選項
? 如果創建成功，右下角會提示Upload Api Success
- step8：進入到yapi查看效果吧
? 介面引數，回傳值，什么的，都有哦
使用體驗
優點
-
基于javadoc，沒有代碼入侵
-
自動生成檔案，契合我們yapi的使用，提升生產力
其余優點可以查看git https://github.com/Forgus/api-generator
缺點
-
第一次使用就發現，如果我們的回傳值是用ResultData封裝過的，回傳引數就沒啥意義了
-
git中介紹的配置，比如Classify API automatically選項，可以獲取控制層注釋，自動創建分類的功能，我打勾了，但是會生成介面失敗
結語
又是提升生產力的一個好東西
參考文獻
可以獲取控制層注釋，自動創建分類的功能，我打勾了，但是會生成介面失敗
結語
又是提升生產力的一個好東西
參考文獻
插件開源地址：https://github.com/Forgus/api-generator
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/249447.html
標籤：其他
上一篇：大資料技術與應用-D1
下一篇：shell2：shell變數