自動更新 Swagger 接口數據到 YApi 平臺

本篇教程主要介紹如何自動更新 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 這類定時任務執行工具，就能夠實現自動更新接口數據，相信聰明的你必定能搞定。