主界面介绍
分组管理菜单
1、项目列表
展示分组内自己所在的项目,点击进入项目详情
2、成员列表
展示和管理分组内的人员构成
1.添加成员
2.更改成员权限
3.删除成员
3、分组动态
展示分组内的项目接口动态
4、分组设置
自定义分组信息
项目
1、接口
1.1 接口列表
添加分类,生成新的接口集合
在分类中添加接口,新增简单接口信息
1.2 接口详情
1.2.1 预览
点击某个接口,进入接口详情--预览
展示详细的接口信息,包括基本信息,请求参数,返回数据等
1.2.2 编辑
点击顶部“编辑”,进入编辑模式
基本设置
接口的基本信息及路径
接口url中有参数的,可以用{}标识
请求参数设置
1.参数类型可以选择 body,query以及headers
2.body参数可以选择对应类型
3.选择form格式可以批量添加参数
4.选择json格式可以直接导入,系统会进行格式校验,通过后会自动解析并填充在下方
返回数据设置
1.返回数据为接口期望的返回结果,也可以已json格式或者raw格式填写
2.选择json格式可以直接导入,系统会进行格式校验,通过后会自动解析并填充在下方
1.2.3 运行
发送--请求此接口
保存--将此接口及请求数据保存至测试合集
1.2.4 高级mock
可以自定义接口返回,设置过滤条件,满足过滤条件时,请求的接口返回则为自定义的返回
此处设置一个期望,打开postman,请求对应的mock地址
参数满足过滤条件,则请求返回为自定义结果
1.3 测试合集
后续更新自动化实施详细讲解
2、动态
api更新修改后,此处可以查看修改记录及修改内容
点击改动详情,可查看接口的具体改动内容。红色表示删除的内容,绿色表示新增的内容。
3、数据管理--快速导入导出标准化接口
3.1-导入
点击弹出下拉框,可选择自己需要的模式
导入成功后,导入的接口会在接口列表中展示
3.2-导出
可将平台中已有的接口数据导出,导出后的文件可以作为数据源再次在其他项目导入。
可以解决项目迁移的问题
4、成员管理
对项目所属成员进行增加,删除,修改权限等操作
5、设置
5.1 项目配置
项目基本信息
5.2 环境配置
1、项目环境管理,可以配置多个不同的环境,在测试接口或者进行自动化测试时可以按需选择对应的环境
2、环境可以增加,可以删除
3、每个环境可以单独设置域名,请求头,全局变量等个性化数据,以满足测试的多样性
5.3 请求配置
可以自定义脚本,分为请求前和请求后的处理。请求前处理脚本,会在接口请求开始前执行,请求后处理脚本,会在请求完成后执行
5.4 token配置
生成唯一项目标识,可以作为请求yapi项目openapi的凭证
非可视化界面操作,yapi提供了部分常用的openapi。
如:进行自动化测试,定期进行接口同步,进行数据导入等等
5.5 全局mock脚本--未研究
5.6 生成ts services 未研究
5.7 swagger自动同步
可以选择时间,选择周期,选择同步方式,定期自动执行接口同步,保证yapi平台中接口为最新接口,不需要人工维护
6、wiki
无特殊功能,可以作为一个记事本,记录项目关联信息