自動更新 Swagger 介面資料到 YApi 平臺

hellosean發表於2018-05-11
SwaggerAPI

本篇教程主要介紹如何自動更新 Swagger 資料到 YApi 介面管理平臺，我們假設你已經能夠熟練使用 YApi介面管理平臺。

配置環境

yapi-cli 依賴 Node.js , 請安裝不低於 7.6 版本的 Node.js，如果你的機器已經安裝了 yapi-cli 工具，且版本號 >= 2.7,可忽略該章節。

安裝 Node.js

方案一: 從 Node.js 官網下載安裝包

方案二: 使用 Node Version Manager(NVM) 安裝 Node.js，你可以通過以下命令安裝 NVM :

cURL:

$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash
複製程式碼

Wget:

$ wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash
複製程式碼

NVM 安裝好以後，重啟終端並執行以下命令來安裝 Node.js :

nvm install stable
複製程式碼

使用 NPM 安裝 yapi-cli

請確保 yapi-cli 工具版本 >= 1.2.7。

npm install yapi-cli [-g]
複製程式碼

使用方法

該功能可在任意一臺機器使用，只需確保該機器能夠連線到部署的 YApi 網站。

第一步：新建配置檔案

在任意一個目錄下新建配置檔案 yapi-import.json，內容如下：

{
  "type": "swagger",
  "token": "17fba0027f300248b804",
  "file": "swagger.json",
  "merge": "good",
  "server": "http://yapi.local.qunar.com:3000"
}
複製程式碼

type 是資料資料方式，目前官方只支援 swagger

token 是專案token，在 專案設定 -> token 設定獲取

file 是 swagger 介面文件檔案，可使用絕對路徑或 url

merge 匯入舊的介面策略，預設使用智慧模式，一共有 "normal"(普通模式) , "good"(智慧合併), "merge"(完全覆蓋) 三種模式

server 是yapi伺服器地址

第二步，執行匯入命令

在新建配置檔案的當前目錄，執行下面指令就能把資料匯入到 yapi 介面管理平臺。

yapi import
複製程式碼

如果提示找不到 yapi 命令，可嘗試執行 yapi-cli,因為部分系統環境不相容。

自動更新

配合 crontab 這類定時任務執行工具，就可以實現自動更新介面資料，相信聰明的你一定能搞定。

相關文章