项目简介
这是一个基于Node.js开发的Yapi插件,名为yapi-plugin-automated-test
。该插件可提供更便捷的接口测试功能与更高效的接口健康监测服务,通过定时自动测试释放人力和物力,节省接口回归时间与其他资源投入。
项目的主要特性和功能
- 支持多计划配置,可依据测试集合定制不同测试计划,定制化程度高。
- 支持定时自动测试,开启后会定时执行测试并向钉钉群机器人推送消息。
- 支持多情况消息推送,可控制钉钉机器人推送消息的方式。
- 服务端自动化测试URL可直接使用Yapi自带的测试集合自动化测试。
- 测试结果列表采用时间轴风格,支持直接查看历史测试结果。
- 配置简单,在分组的项目导航栏中加入“自动化测试”标签即可进行配置。
安装使用步骤
安装插件
正常安装
- 在
config.json
所在目录下运行命令yapi plugin --name yapi-plugin-automated-test
来安装插件。 - 重启Yapi服务。
本地安装
- 下载插件并复制到本地,然后拷贝到Yapi目录的
项目目录/vendors/node_modules/
下面。 - 修改Yapi目录下的
config.json
文件,添加插件相关配置。 - 使用
ykit pack -m
命令打包后重启服务。
更新插件
- 删除
./vendors/node_modules/.ykit_cache
文件夹以清除ykit缓存。 - 修改
package.json
里yapi-plugin-automated-test
的版本,或者直接执行npm i yapi-plugin-automated-test@version
。 - 在
./vendors/
目录中执行命令NODE_ENV=production ykit pack -m
。 - 在
config.json
所在目录下执行命令yapi plugin --name yapi-plugin-automated-test
,然后重启服务器。
使用说明
维护测试集合
配置插件
- 在项目导航栏中找到自动化测试配置入口。
- 通过测试集合 -》服务端测试获取服务端自动化测试URL并直接使用。
- 配置钉钉群机器人的webhook。
查看测试结果
- 在Yapi项目的动态页面查看。
- 在配置的钉钉群聊里通过钉钉机器人查看。
- 在插件的测试结果列表中查看。
注意事项
钉钉每个机器人每分钟最多发送20条消息,详情参考消息发送频率限制。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】