数据导入
在数据管理可快速导入其他格式的接口数据,方便快速添加接口。YApi 目前支持 postman, swagger, har 数据导入。
Postman 数据导入
1.首先在postman导出接口
2.选择collection_v1,点击export导出接口到文件xxx
3.打开yapi平台,进入到项目页面,点击数据管理,选择相应的分组和postman导入方式,选择刚才保存的文件路径,开始导入数据
HAR 数据导入
可用 chrome 实现录制接口数据的功能,方便开发者快速导入项目接口
1.打开 Chrome 浏览器开发者工具,点击network,首次使用请先clear所有请求信息,确保录制功能开启(红色为开启状态)
2.操作页面实际功能,完成后点击save as HAR with content,将数据保存到文件xxx
3.打开yapi平台,进入到项目页面,点击数据管理,选择相应的分组和har导入方式,选择刚才保存的文件路径,开始导入数据
Swagger 数据导入
什么是 Swagger ?
1.生成 JSON 语言编写的 Swagger API 文档文件
Tips: v1.3.19 版本开始支持swagger url 导入功能
2.打开yapi平台,进入到项目页面,点击数据管理,选择相应的分组和swagger导入方式,选择刚才的文件,开始导入数据
YApi接口JSON数据导入
该功能在 v1.3.12 版本上线,可导入在 yapi 平台导出的 json 接口数据。
通过命令行导入接口数据
YApi 支持通过命令行导入接口数据,他的应用场景是做自动化集成,比如配合 swagger ,接口文档前端不用维护,交由后端生成。
使用方法
第一步,确保 yapi-cli >= 1.2.7
版本,如果低于此版本请升级 yapi-cli
工具
npm install -g yapi-cli
第二步,在任意一个目录下新建配置文件 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 import