YMFE/yapi

yapi 使用问题总结

Open

#255 opened on Apr 19, 2018

View on GitHub
 (34 comments) (4 reactions) (0 assignees)JavaScript (26,999 stars) (4,732 forks)batch import
help wanted

Description

1.找不到分组创建,成员管理功能

请使用部署的管理员账号登录,登录成功后点击红色框里的 icon 创建分组,分组创建成功后,进入该分组,可查看到分组成员管理功能 image

2.如何查看接口改动信息?

进入到项目,点击动态,然后选择想查看的接口,可查看到所有的改动信息。

3.前端如何获取 mock 数据?

创建项目后,新增一个接口,编辑接口返回数据,完成后点击保存,可复制预览页面的 mock地址,请求该地址就能拿到 mock 数据。

项目 -> 接口编辑 image

项目 -> 接口预览 image

4. 遇到特定字段需要返回不同mock数据的情况怎么办

接口 -> 高级mock

通过期望或者自定义脚本的方式定义特殊格式的mock数据

5. 遇到有项目需要返回固定的mock字段时要怎么办?

打开 项目设置 -> 全局mock脚本, 代码如下:

if(mockJson && typeof mockJson === 'object') {
  mockJson.code=0
}

在全局mock中可以自定义mock占位符

6. 测试用例里面为什么没有接口编辑中定义的示例数据?

测试用例中的数据需要自己填写,点击更新可以将测试用例中的数据保存起来方便下次调试。每一个测试用例中可以保存不同的环境变量方便自动化测试时使用 image

7. 自动化测试

自动化测试时可以拉取上一个接口的参数和返回值,具体如何编辑测试用例见教程。 遇到接口加密,获取上一接口的cookie数据等特殊数据情况的时候,请在 项目设置 -> 请求配置里面设置。 请求配置只在自动化测试里面才会生效

8. 接口错误描述写在哪里

如果每个接口都不一样可以写到接口的备注里面,如果整个项目的错误描述是一样的,可以将这些信息写到wiki中

9. 如何确保前端mock请求的数据符合定义接口的规范

mock请求严格模式

10. 在接口运行中如何对返回数据格式进行校验

版本 v1.3.22 新增返回数据验证功能, 如果接口的返回数据格式为json-schema 在接口运行时会对接口返回数据和定义数据格式进行校验, 校验内容可以是必须字段是否存在(将该字段设置为required), 字段的返回值类型,字段取值是否在枚举取值之内等等

11. 自动化测试如何获取接口的cookie数据并提供给后面的接口使用(注: 这种方式不适用服务端测试)

image

12. 总结

前端 mock 的详细使用方法。可能会用到高级mock , 全局mock, 在json-schema 中默认值解析不会起作用,要想固定某个变量的解析值可以使用枚举的方式。

接口测试, 请求配置和断言只在自动化测试时才会生效,每个测试用例都可以保存一个环境变量

Contributor guide