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

刺骨的言语ヽ痛彻心扉 2024-03-23 22:15 68阅读 0赞

**目录**

实践场景

定义返回响应

场景数据准备

校验响应数据

总结

--------------------

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

使用 **[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 类型。

![ddd70befe7fb4767a187242cb1266f08.png][]

**规范二：range 参数成功响应**

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

![7c6fee07a7994723858140a88088ce0c.png][]

**规范三：other 参数成功响应**

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

![00844c138ffb46e98875c2aacd6a9802.png][]

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

### **场景数据准备** ###

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

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

![5bbd38955b8a4afab1fb673d2e6ee92b.png][]

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

![2dd89630d5c14d8298acfdf2ed5907ab.png][]

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

![7d3c77e1f24548f58058aaae6f956ba9.png][]

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

![082ee3ed3f5d4962960f0aa77f5bc861.png][]

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

![51ccb780c7fd4a11b0755e4c37e34885.png][]

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

![f4b2119cca614787a6396d6605e4e7fe.png][]

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

### **校验响应数据** ###

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

**校验「规范一」**

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

![2f52a7a74330424daac4865158bea17e.png][]

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

![7d37dbdf6a434cd8b5509650a65c833a.png][]

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

![6425a973df874f79a80991d01e00d3a0.png][]

**校验「规范二」**

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

![e464e3ac380f49c0aebc25bcc2048cbe.png][]

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

![e4cd02924c624dceaec0735cee4f22e5.png][]

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

![3852aee6fe0e4ef9a24141e584014440.png][]

**校验「规范三」**

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

![96e5b3597cb34eae99d75e38c790154c.png][]

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

![612af4b248ec43ab9e23e0108fd55c10.png][]

### **总结** ###

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

--------------------

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

![c1653dd19f35495583cef3678b57b6b0.png][]

![775632765b6744fbbecbd8fdd097d1ab.png][]

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

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

[Apifox]: https://link.juejin.cn?target=https%3A%2F%2Fapifox.com%2Fapiskills%2Finterface-debugging-tools%2F
[ddd70befe7fb4767a187242cb1266f08.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/ca75d6d4f7ed46cd939a1384e3b5b545.png
[7c6fee07a7994723858140a88088ce0c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/53312316842549f3862ae4ff68b72fa4.png
[00844c138ffb46e98875c2aacd6a9802.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/57fcb82319084843ac72cf74483c1cc4.png
[5bbd38955b8a4afab1fb673d2e6ee92b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/80d1f6fa3591443cadc8cdc40ad359fb.png
[2dd89630d5c14d8298acfdf2ed5907ab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/c052debd26184874ba2609370a579c4a.png
[7d3c77e1f24548f58058aaae6f956ba9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/1aa81cd69a5a477a873b05850739a007.png
[082ee3ed3f5d4962960f0aa77f5bc861.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/eb02d64dd35b472f85061609a8e655dc.png
[51ccb780c7fd4a11b0755e4c37e34885.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/0bacbc8efed640b89708d24a6df77aca.png
[f4b2119cca614787a6396d6605e4e7fe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/6fef9626a7034e7abdd3f432d2aa8805.png
[2f52a7a74330424daac4865158bea17e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/ce8c3988cae148419abb66b9f701541f.png
[7d37dbdf6a434cd8b5509650a65c833a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/ee83aac0bbbe40d79947ccf42e410e89.png
[6425a973df874f79a80991d01e00d3a0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/90caaa89139c4a36834ffce511d4b312.png
[e464e3ac380f49c0aebc25bcc2048cbe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/7c17ba25921c4d54a6fea6a8ea269962.png
[e4cd02924c624dceaec0735cee4f22e5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5e21f6418cb6408b9cbb9d3d8b8633e6.png
[3852aee6fe0e4ef9a24141e584014440.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/1b2e655a72634cacae880f0a05f4b258.png
[96e5b3597cb34eae99d75e38c790154c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/278076d06c9f4fca8eac873515227759.png
[612af4b248ec43ab9e23e0108fd55c10.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/733a8df8c6bc42cc99801587b8bcf900.png
[c1653dd19f35495583cef3678b57b6b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/c55fe4960726403dbb9ad2acf16fd83b.png
[775632765b6744fbbecbd8fdd097d1ab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/ed9256d07de1442db5f7d2caf1447392.png