提高生产力 | Apifox 数据结构验证最佳实践

目录

实践场景

定义返回响应

场景数据准备

校验响应数据

总结


在设计接口的过程中,响应数据需要和返回响应规范一一对应。这样能够确保接口的一致性和可靠性,并且方便接口的使用和维护,即使在后续迭代过程中出现问题,开发人员与测试人员也能快速排查解决。

使用 Apifox 可以自动校验接口返回的数据结构是否规范,而无需手动写断言脚本检测。下文将通过一个示例场景进行实践演示。

实践场景

假设存在以下场景:

一个对象中有两个属性:

  • type: 枚举 string
  • values: 数组 array

现在要求:

  • type 值为 fixed 时,values 长度为 1;
  • type 值为 range 时,values 长度为 2;
  • type 值为 other 时,values 则无长度限制。

在这个场景中,如何在 Apifox 中基于 type 值限制 values 的长度,从而实现两者的关系无法对应时返回错误响应?

先根据要求列出所有可能的数据结构规范:

// 第一种
{
  "type": "fixed",
  "values": ["1"]
}

// 第二种
{
  "type": "range",
  "values": ["1","2"]
}

// 第三种
{
  "type": "other",
  "values": ["1","2","89","67"]
}

定义返回响应

根据需求,符合预期的响应数据与返回响应存在以下 3 种对应情况,反之则返回错误响应。

规范一:fixed 参数成功响应

设置 type 为 string 类型,添加枚举值为 fixed;设置 values 为 array 类型,并限制其输出的元素个数仅为 1,其内元素为 string 类型。

提高生产力 | Apifox 数据结构验证最佳实践_第1张图片

规范二:range 参数成功响应

设置 type 为 string 类型,添加枚举值为 range;设置 values 为 array 类型,并限制其最大最小元素个数均为 2,其内元素为 string 类型。

提高生产力 | Apifox 数据结构验证最佳实践_第2张图片

规范三:other 参数成功响应

设置 type 为 string 类型,添加枚举值为 other;设置 values 为 array 类型,其最大最小元素个数均不做限制,其内元素为 string 类型。

提高生产力 | Apifox 数据结构验证最佳实践_第3张图片

定义成功响应示例后,使用者通过接口发起请求的时候,可以通过响应状态来确定返回的接口数据是否符合规范。

场景数据准备

可以使用 Apifox 的高级 Mock 功能来模拟接口数据。根据场景描述,我们需要为其定义 5 种不同类型的 Mock 数据,分为 3 种成功校验,2 种失败校验。

选择「文档模式」,点击「高级 Mock」选项并新建期望。

提高生产力 | Apifox 数据结构验证最佳实践_第4张图片

新增「当 type 值为 fixed 时 values 长度为 1」的期望:

提高生产力 | Apifox 数据结构验证最佳实践_第5张图片

新增「当 type 值为 range 时 values 长度为 2」的期望:

提高生产力 | Apifox 数据结构验证最佳实践_第6张图片

新增「当 type 值为 other 时则 values 无长度限制」的期望:

提高生产力 | Apifox 数据结构验证最佳实践_第7张图片

新增「当 type 值为 fixed 时 values 长度不为 1」的期望:

提高生产力 | Apifox 数据结构验证最佳实践_第8张图片

新增「当 type 值为 range 时 values 长度不为 2」的期望:

提高生产力 | Apifox 数据结构验证最佳实践_第9张图片

Mock 数据定义完成后即可调用接口并校验返回响应中数据结构的规范。

校验响应数据

响应数据和返回响应规范需存在对应关系,否则将会提示校验不通过。在接口调用过程中及时对返回结果进行必要的验证和校验,以此确保返回结果的正确性和完整性。这可以有效地减少接口调用失败或出错的几率,确保接口的一致性和可靠性,减少后期的维护成本。

校验「规范一」

在「规范一」中,要求当 type 的值为 fixed 时,values 数组中仅输出 1 个数值才视为通过数据结构校验:

提高生产力 | Apifox 数据结构验证最佳实践_第10张图片

如果 type 的值不为 fixed,则返回的数据结构校验出错:

提高生产力 | Apifox 数据结构验证最佳实践_第11张图片

如果 values 的值为 null 或者多于 1 个,数据结构校验时也会报错:

提高生产力 | Apifox 数据结构验证最佳实践_第12张图片

校验「规范二」

在「规范二」中,要求当 type的值为 range 时,values 数组中仅输出 2 个数值才视为通过数据结构校验:

提高生产力 | Apifox 数据结构验证最佳实践_第13张图片

如果 type 的值不为 range,则返回的数据结构校验出错:

提高生产力 | Apifox 数据结构验证最佳实践_第14张图片

如果 values 的值为 null 或不为 2 个值,数据结构校验时也会报错:

提高生产力 | Apifox 数据结构验证最佳实践_第15张图片

校验「规范三」

「规范三」的要求则较为宽松,当 type的值为 other 时,无论 values 数组中输出多少个数值都会被视为通过数据结构校验:

提高生产力 | Apifox 数据结构验证最佳实践_第16张图片

 如果 type 的值不为 other,则返回的数据结构校验同样会报错:

提高生产力 | Apifox 数据结构验证最佳实践_第17张图片

总结

根据上面的案例,我们可以了解到在 Apifox 中定义数据结构、校验接口数据是否规范是非常便捷的。想要了解更多相关的知识,如接口的导入、Mock 数据和自动化测试等功能。


以下是我收集到的比较好的学习教程资源,虽然不是什么很值钱的东西,如果你刚好需要,可以评论区,留言【777】直接拿走就好了

各位想获取资料的朋友请点赞 + 评论 + 收藏,三连!

三连之后我会在评论区挨个私信发给你们~

你可能感兴趣的:(软件测试,接口测试,前端,程序人生,软件测试,软件测试工程师,接口测试,apifox)