根據後端提供的swagger生成前端的配置檔案
根據後端提供的swagger生成配置檔案(JavaScript檔案)【簡單的說,就是生成api目錄】
github地址在這裡:github.com/littleHiuma…
用法
假設後端提供的swagger地址是http:255.255.255.255:3000/swagger-ui.html ,只需要取前面部分就可以了(ip加埠)
一個ip的情況下: node generateIt.js --ip=http:255.255.255.255:3000
多個ip的情況下(使用,來分割): node generateIt.js --ip=http:255.255.255.255:3000,http:255.255.255.254:1000
說幾句
(重要的事情說三遍)
生成之前會先刪掉資料夾裡面的內容,受影響的話,請把內容移動到其他資料夾!!!
生成之前會先刪掉資料夾裡面的內容,受影響的話,請把內容移動到其他資料夾!!!
生成之前會先刪掉資料夾裡面的內容,受影響的話,請把內容移動到其他資料夾!!!
生成之後會有一句提示:一共n個模組
這個模組是按請求url來劃分的,比如:
/adminUser/test、/adminUser/jest 這兩個就屬於一個模組(adminUser模組)
/adminUser/test、/test/adminUser 這兩個就屬於兩個模組(adminUser模組,test模組)
生成的資料夾是有順序的(和ip順序一樣),資料夾名稱暫定是api加索引(api0、api1、…apin)
是在執行該工具的目錄下生成的
因為是根據swagger來生成的配置檔案,後端對介面描述越詳細越好
我們這裡的後端提供的swagger對介面描述的不是特別詳細(比如圖中有的欄位沒有描述),所以這個工具的提升空間很大(哈哈哈)
下面的圖中的請求引數的型別使用的是後端定的型別,我沒有去處理…(我加到下面的問題裡了)
還有就是!如圖,import request from '@/utils/request'
這一句我暫時是寫死的(我加到下面的問題裡了)
已發現的問題:
- 如果後端對引數型別描述不準確,得人力去改…(哭
- 請求引數的型別使用的是後端定的型別
- request檔案的引入和命名,暫時是寫死的(
import request from '@/utils/request'
- 匯出檔案這種型別的介面(返回值是檔案),需要自己新增
responseType: 'blob'
- 函式的方法名可能會出現JavaScript的關鍵字(2020-11-30補充)
對您有幫助的話,麻煩幫我點個star呀!
歡迎大家來完善這個工具或者提問題反饋一下呀!
這個工具僅作學習和輔助使用哦。
作者:hiuman
連結:https://juejin.cn/post/6900093883309686797
來源:掘金
著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。