如何保证开发给到你的接口文档就是正确的?

项目简介

面试官可能会问:如何保证开发给到你的接口文档就是正确的。站在测试的角度如何去保证接口测试一个正确性?

答案解析

站在测试的角度,首先通过流程,在研发的概要设计评审环节,即可与产品、前端一起,针对后端的接口文档进行评审,在接口设计阶段就尽量保证研发设计的接口是合规、合理且满足需求的。

在评审与测试过程中,可以主要从以下几个角度考虑接口文档的正确性:

  • 是否符合需求
    • 是否满足使用场景。
  • 规范性
    • 文档相关的描述是否清晰准确
    • 响应状态码是否符合规范
    • 错误返回是否全面
  • 字段正确性
    • 是否遗漏:比如界面展示需要姓名,对应的接口有没有相关的姓名的字段
    • 是否冗余:接口是否给出无用的响应字段,比如此页面只需 A、B、C 三个字段,接口却返回了 ABCDEF 六个字段
    • 类型是否正确:字段是否都使用符合其语义的类型,比如年龄使用int类型
    • 必填非必填:根据需求考虑此字段应该是必填还是非必填
  • 是否需要考虑幂等性:比如接口如果重复多次提交,应该如何返回
1 个赞