swagger重启_自动更新 Swagger 接口数据到 YApi 平台

自动更新 Swagger 接口数据到 YApi 平台

本篇教程主要介绍如何自动更新 Swagger 数据到

YApi 接口管理平台

, 我们假设你已经能够熟练使用 YApi 接口管理平台 https://yapi.ymfe.org .

配置环境

yapi-cli 依赖 Node.js , 请安装不低于 7.6 版本的 Node.js, 如果你的机器已经安装了 yapi-cli 工具, 且版本号 >= 2.7, 可忽略该章节.

安装 Node.js

方案一: 从 Node.js https://nodejs.org/en/ 官网下载安装包

方案二: 使用 Node Version Manager(NVM) https://github.com/creationix/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":false,

"server":"http://yapi.local.qunar.com:3000"

}

type 是数据数据方式, 目前官方只支持 swagger

token 是项目 token, 在

项目设置 -> token

设置获取

file 是 swagger 接口文档文件, 可使用绝对路径或 url

merge 是否覆盖旧的接口, 默认不开启, 配置 true 开启

server 是 yapi 服务器地址

第二步, 执行导入命令

在

新建配置文件的当前目录

, 执行下面指令就能把数据导入到 yapi 接口管理平台.

yapi import

如果提示找不到 yapi 命令, 可尝试执行 yapi-cli, 因为部分系统环境不兼容.

自动更新

配合 crontab 这类定时任务执行工具, 就可以实现自动更新接口数据, 相信聪明的你一定能搞定.

来源: https://juejin.im/post/5af500e251882567096140dd