1、案例描述
-
用户选择短信登录
短信登录.png -
发送短信后，后端接口逻辑已把验证码缓存在redis，
redis数据.png - 在
apifox上定义对应下发登录短信接口，短信登录接口
下发登录短信接口.png
短信登录接口.png - 这时候问题就来了，怎么样才能让
apifox自动获取下发登录短信接口对应的手机号的验证码，自动填充到短信登录接口的code字段？
怎么自动获取验证码.jpg
2、解决思路
- 方案一：后端通过接口返回验证码，下发短信接口后再调用该接口去获取验证码（正式环境需要屏蔽该接口，没办法自动化正式环境接口）
- 方案二：
apifox直接访问redis获取数据；这需要在apifox添加扩展操作redis的jar包，参考：https://www.apifox.cn/help/app/scripts/api-references/external-programs/ （该方案比较可行）
3、开始动手
编写操作redis扩展jar包（可参考https://github.com/Atoms-Cat/apifox-code的apifox-redis模块）
-
创建自动化测试用例，我是从
接口管理的接口用例直接导入（这个工具真香，重用性强👍）
导入接口用例.png -
把
phone、code请求参数给为临时变量{{phone}}、{{code}}
下发登录短信用例.png
短信登录用例.png 新建
短信登录用例前置自定义脚本，这里的apifox-redis-1.0-SNAPSHOT.jar，就是第一步生成好的jar；脚本编写可以参考：https://www.apifox.cn/help/app/scripts/pre-request-script/#%E4%BD%BF%E7%94%A8%E7%A4%BA%E4%BE%8B
try {
// redis 连接配置
var redisConfig = "{\"host\":\"192.168.181.130\",\"password\":\"123456\",\"database\":0}";
// 获取当前登录的手机号
var phone = pm.variables.get("phone");
// 后端服务缓存验证码在redis的key
var key = "DEFAULT_CODE_KEY:" + phone;
console.log("redis key:", key);
// 执行jar包获取redis缓存数据
var jarResult = pm.execute('apifox-redis-1.0-SNAPSHOT.jar', [redisConfig, "GET", key]);
console.log("redis 缓存数据：", jarResult);
// 反序列化异常处理
var code = jarResult.substr(jarResult.length-7, 6);
// 自动填充验证码到登录接口的`code`字段
pm.variables.set("code", code);
console.log("验证码：", code);
} catch (e) {
console.error(e.message);
}
短信登录用例前置自定义脚本.png
-
新增
测试数据，这里新增手机号对应临时变量{{phone}}
测试数据.png -
注意: 需要打开测试数据开关，后点击运行
运行测试用例.png -
查看结果
自动化结果.png
登录接口返回参数.png
apifox操作redis运行结果.png
4、总结
apifox提供了非常好的自动化测试接口的功能
自动化测试登录接口流程.jpg
参考demo源码
# 后端接口服务源码
https://github.com/Atoms-Cat/softswitch-system
# apifox 扩展操作 redis jar源码
https://github.com/Atoms-Cat/apifox-code
