前言
受新型冠狀病毒的影響,在家像豬一樣不是睡就是吃,閒着就學着用下Swagger和YApi,特將這幾天的學習成果寫成了這系列的文章,希望能對大家有所幫助。武漢加油,中國加油!
Spring Boot 1.5.8集成Swagger2 + YApi —— 集成Swagger2
Spring Boot 1.5.8集成Swagger2 + YApi —— Swagger常用註解說明
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安裝mongoDB
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安裝YApi(在線安裝)
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安裝YApi(離線安裝)
Spring Boot 1.5.8集成Swagger2 + YApi —— swagger接口信息導入YApi
現在swagger的接口已經生成好,YApi也已經部署好了,如何將swagger的接口信息導入到YApi,本文將介紹兩種導入的方式:
導入接口信息首先要知道導入接口信息的時候的接口數據同步方式,一共有三種同步方式,後面會用到:
- 普通模式(normal):不導入已存在的接口;
- 智能合併(good):已存在的接口,將合併返回數據的 response,適用於導入了 swagger 數據,保留對數據結構的改動;例如,用戶對字段code 添加了mock信息, 當再次數據導入的時候 mock 字段將不會被覆蓋
- 完全覆蓋(mergin):不保留舊數據,完全使用新數據,適用於接口定義完全交給後端定義, 默認爲 normal
一、json文件導入的方式
這種方式需要登入到YApi管理平臺,稍微麻煩一點
1,導出swagger的接口信息json
登陸訪問swagger的接口信息鏈接:
http://localhost:項目啓動端口/項目名/v2/api-docs
瀏覽器會返回一個json字符串,將該字符串複製下來,並保存爲json文件的格式
注意:
保存爲json格式的時候,json文件用UTF-8的編碼格式進行保存
2,導入json文件
進入YApi項目中的數據管理頁面,路徑爲:
選擇項目 > 數據管理 > 數據導入
數據導入頁面爲:
選擇導入剛剛保存的json文件即可。再返回該項目的接口頁面,即可看到剛剛導入的接口信息:
再次強調一下,導入的json文件必須是UTF-8的格式,否則中文會亂碼!
二、yapi-cli導入
此種方式是通過node安裝yapi-cli來進行操作,需要事先安裝node纔可使用,使用此種方式不需要保存json文件和進入YApi管理平臺,效率更高,推薦!
1,安裝yapi-cli
安裝命令:
npm install -g yapi-cli
如果已經安裝了yapi-cli,請確保版本 >= 1.2.7,如果低於此版本,需要升級下yapi-cli
2,新建配置文件yapi-import.json
在本機任一目錄新建一個名爲yapi-import.json
的文件,複製一下內容:
{
"type": "swagger",
"token": "17fba0027f300248b804hdshdsjfldsjfouiesfwe434i43it409jijkdsjkfjdsfuew",
"file": "http://localhost:9801/hbs/v2/api-docs",
"merge": "normal",
"server": "http://localhost:3000"
}
- type:固定爲swagger
- token:你的用戶下需要需要上傳接口數據的項目的token,可以在YApi管理平臺上看到,獲取方法下面介紹
- file:token文件的相對或者絕對路徑,也可以是url
- merge:合併方式,三種合併方式文章開頭有介紹,按照自己需求填寫
- server:YApi服務器的部署的地址
token查看方法:
進入YApi管理平臺,選擇需要上傳接口數據的項目,點擊 設置 > token配置,即可看到token,如下圖所示:
3,運行指令上傳
命令行進入剛剛創建yapi-import.json
的文件夾,在該路徑下運行命令:
yapi import
上傳完成:
以後開發,每次更新swagger的接口信息後,只需要進入yapi-import.json
文件所在的路徑,運行下yapi import
指令就可以更新YApi平臺上的接口信息啦,十分方便