YApi使用

[mominger]

YApi使用

• YApi官网
• YApigithub地址

基本操作

1. 登录界面

个人空间只有自己可以看到

2. 创建一个Hello Api

1. 添加一个分组
   
2. 分组管理
   > 分组只有管理员可以创建

分组可以理解为公司某部门，部门下很多项目
如果原来有分组，可以直接进入第2步，创建项目

3. 添加一个项目
   >
   
   
4. 添加一个Hello Api
   

分类类似于单个需求。比如一个需求是用户管理。里面有用户登录、注册、注销等各接口

5. 使用Hello Api
   
   
   
   

注意：运行那里需要装chrome插件，如果装不成功，点这里 YApi本地安装chrome插件
基本使用已到此结束。进一步深入查阅YApi官网教程
下面针对项目遇到的实际问题进行阐述

FAQ

1. 默认响应的mock数据会每次随机变化，如何让接口每次响应同样的数据？比如demo演示时，希望数据每次响应不变，看起来像真的

• 增加期望过滤
• 
• 

优先级 期望 > 接口mock脚本 > 项目mock脚本
更灵活、复杂、动态的设置去mock脚本里撰写

2. 如何让接口动态响应预期的数据？比如针对各种场景接口响应不同的数据

• 增加mock脚本
• 

这里只是举例，更复杂的写法请查阅YApi官网教程
如果针对项目的各种异常响应，可以写到全局mock脚本
脚本注意点开启，才会生效

3. 后台如何在转测前，上线前 对接口做自动化测试

• 建立测试集，撰写断言
  
  
• 执行测试
• 
• 

服务端一键测试URL可以集成到jenkins

4. 后台如何把接口数据批量导入YApi

• 后台输出swagger数据，然后在YApi配置定时采集swaager数据
  
  

5. 后台如何拿到接口文档

导出的html文档格式截图

6. 后台如何在让接口每天定时自动测试？比如每天晚上0点定时做接口测试，第二天早上来查阅

• 需先给平台安装 YApi自动化测试插件
• 然后在自动化插件里 设置定时，输入一键测试的URL

7. 现有YApi不满足业务，如何对YApi做扩展？

• 首先去npm平台上搜索插件包，一般都能找到解决的插件
• 实在没有，YApi抛出各种操作的钩子函数，需参考官方的插件例子进行定制开发

8. 其他

• 接口数据变更后，覆盖原有接口，建议选智能模式。 三种模式:完全覆盖，智能模式(以新数据为主，比如原接口多出来的字段会删掉，但是
  原接口字段的注释等会保留)，普通模式(新数据和旧数据合并到一起)

反馈与建议

• 谭文斌 智慧教育业务中心
• 微信:
• 邮箱: [email protected]