yapi icon indicating copy to clipboard operation
yapi copied to clipboard

yapi 使用问题总结

Open hellosean1025 opened this issue 6 years ago • 34 comments

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 中默认值解析不会起作用,要想固定某个变量的解析值可以使用枚举的方式。

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

hellosean1025 avatar Apr 19 '18 08:04 hellosean1025

部署的账号是多少。我部署了,不知道账号

silverWolf818 avatar May 07 '18 14:05 silverWolf818

 image

gaoxiaomumu avatar May 08 '18 08:05 gaoxiaomumu

docker内升级yapi新版本

docker exec -it yapi(容器名称) sh

npm install -g yapi-cli

yapi-cli update

91wangmeng avatar May 08 '18 09:05 91wangmeng

请问内网部署怎么迁移数据

jacentsao avatar May 14 '18 03:05 jacentsao

_20180703210215

运行了 ykit s -p 4000 全是这种错,不知道什么情况。。。

jsspace avatar Jul 03 '18 13:07 jsspace

请问yapi Json-schema 的$ref功能怎么配置呢

calmzhu avatar Jul 06 '18 07:07 calmzhu

@calmzhu yapi 的 json schema 没有 $ref ,但是我们会对swagger导入的数据进行解析 用的是json-schema-faker 这个库

gaoxiaomumu avatar Jul 12 '18 06:07 gaoxiaomumu

升级版本1.3.18之后打不开页面 报错: keysFunc is not a function

hannq avatar Jul 13 '18 02:07 hannq

将浏览器的缓存清一下试试

gaoxiaomumu avatar Jul 13 '18 03:07 gaoxiaomumu

导入的时候没有问题。不过导入后维护有问题。 就是这样的情景。

/user 接口返回一串json /user_analyse返回一串另一串json.其中包括/user的json内容。

在做 response data mock时。请问这种引用的维护处理有什么建议么。 现在都不在yapi里面改数据了。都是在swagger改。改完导入。更新起来不方便。

calmzhu avatar Jul 25 '18 06:07 calmzhu

没有啥好的建议

gaoxiaomumu avatar Jul 25 '18 08:07 gaoxiaomumu

项目采用nohup 运行指令 & 运行 项目自动闪退是什么情况

gclm avatar Aug 06 '18 14:08 gclm

@calmzhu 你现在是怎么处理这种情况的

LeonDevLifeLog avatar Aug 22 '18 02:08 LeonDevLifeLog

@LeonDevLifeLog 还没有好的处理方法。现在只能人肉

calmzhu avatar Aug 26 '18 04:08 calmzhu

@calmzhu :joy:

LeonDevLifeLog avatar Sep 03 '18 01:09 LeonDevLifeLog

配置文件设置了邮箱信息,集合里面点击服务端运行,开启邮箱以及下载数据,运行后生成测试报告,但是无邮件信息

dreamer1314 avatar Sep 05 '18 05:09 dreamer1314

@dreamer1314 需要用管理账户打开系统信息,查看邮件配置是否成功

image

测试报告只有在测试不通过的时候才会发送邮件

gaoxiaomumu avatar Sep 17 '18 04:09 gaoxiaomumu

发现个问题,登录后许久不用了,然后编辑api返回的json(很复杂),结果一点保存,就跳转了,刚刚写的复杂的json又需要重新来一遍😂

serical avatar Feb 18 '19 07:02 serical

只有超级管理员有权限创建分组嘛?实测发现用户角色member也能创建,但是不能删除。 版本: 1.5.4

netblack avatar Mar 13 '19 09:03 netblack

开放接口或者开放分类希望能在未登录情况下访问; 另外导出接口时希望能选择接口

warthur1214 avatar Mar 21 '19 06:03 warthur1214

image 请教下,这个还是跨域的,,这种代码直接用url访问接口,yapi是怎么解决跨域问题的

Ucdit avatar Mar 27 '19 15:03 Ucdit

请问内网部署怎么迁移数据

备份MongoDB就可以了啊

Ryan-Miao avatar Apr 01 '19 10:04 Ryan-Miao

image image

设置了默认值,为什么运行的json参数都是一些奇怪的字符, 而不是我设置的默认值, 没有值,为什么不是默认显示为"",双引号的空

xiangfenr avatar Apr 10 '19 02:04 xiangfenr

image image 找到了答案,设置枚举

xiangfenr avatar Apr 10 '19 03:04 xiangfenr

使用导出docx插件,点击导出是Not Found,是哪里没有配置好?

goodzhou avatar Apr 16 '19 08:04 goodzhou

我系统用起来很方便,感谢各位开发人员。在使用中我遇到一个问题,就是系统的进程有时候会突然cpu使用达到100%以上,导致系统不能正常使用了,需要重启服务才行。我使用的是pm2来维护进程 image 重启后 image

ovejur avatar Apr 24 '19 01:04 ovejur

我系统用起来很方便,感谢各位开发人员。在使用中我遇到一个问题,就是系统的进程有时候会突然cpu使用达到100%以上,导致系统不能正常使用了,需要重启服务才行。我使用的是pm2来维护进程 image 重启后 image

我也遇到了一样的问题,用mock接口或者其他不知道的原因,然后就估了,也是用pm2维护 看日志并没有错误

N2XK avatar May 14 '19 08:05 N2XK

image image

各路大神,点击环境配置页面就不出来,js报错,是什么问题呢? 之前好的。

wangsilu avatar Jun 04 '19 04:06 wangsilu

@wangsilu 升级到最新版试试

hellosean1025 avatar Jun 05 '19 08:06 hellosean1025

image 数据预览的那个表格,能不能默认全展开啊?即上图的 data 不处于折叠状态 这样每次看数据要点开好多级,好麻烦啊 @hellosean1025

lemon-clown avatar Sep 04 '19 09:09 lemon-clown