深入理解接口测试：实用指南与最佳实践（三）API文档解析及编写测试用例

​
​

您好，我是程序员小羊！

前言

这一阶段是接口测试的学习，我们接下来的讲解都是使用Postman这款工具，当然呢Postman是现在一款非常流行的接口调试工具，它使用简单，而且功能也很强大。不仅测试人员会使用，开发人员也会 经常使用。这节课是Postman分析的请求和响应数据，完成ihrm系统指定接口的API文档解析掌握接口测试用例设计方法，能独立完成ihrm系统登录/员工管理相关接口用例设计，后期讲解大概分三部分进行讲解：
1、根据接口API文档编写接口测试用例
2、使用Postman工具进行接口测试，并能够对大量接口用例进行管理、对接口响应结果进行断言、处理多接口的依赖及生成测试报告
3、使用Python+Requests封装的接口测试框架，实现接口对象封装、测试用例编写、测试数据管理及生成测试报告

先进入正题之前，我们先了解接口测试的相关的知识，如测试流程…

一、接口测试流程

---

1. 需求分析（产品经理的需求文档）
2. 接口文档解析（开发编写的 接口API文档）
3. 设计 接口测试用例（编写 Excel 表格形式的⽤例）
4. 准备接口测试脚本 （设计测试用例）
   postman 工具 生成脚本
   python 代码 编写脚本
5. 执行测试用例，跟踪缺陷
6. 生成 接口测试报告
7. 接口自动化持续集成（可选）

---

二、什么是接口文档？

接口文档：又称为API文档，一般是由后端开发人员所编写的，用来描述系统所提供接口信息的文档。 大家都根据这个接口文档进行开发，并需要一直维护和遵守。
作用：
协同：团队⼈员⼯作协同配合
约束：项目更新修改同步维护

三、为什么要写接口文档？

1. 能够让前端开发与后台开发人员更好的配合，提高工作效率。（有一个统一参考的文件）
2. 项目迭代或者项目人员更迭时，方便后期人员查看和维护
3. 方便测试人员进行接口测试

四、为什么要解析接口文档

通过分析接口文档，熟悉接口信息。
通过接口文档获取，接口测试所使用的 请求数据、预期结果。

解析的核心目标：

1. 请求报文关键数据 请求方法、URL、请求数据（请求头、请求体）
2. 响应报文关键数据 响应状态码、响应数据（响应体）

四、接口文档内容

一个规范的接口文档，要包含以下信息：
基本信息 ：接口名称、请求方法、请求路径、接口描述
请求参数：请求头请求体（包含具体的请求参数名称、参数类型、是否必须、示例、备注）
返回数据：不同情况的响应状态码响应数据（包含具体的响应数据名称、类型、是否必须、默认值、示例、备注）

案例如下：

五、接口测试用例设计

六、接口用例设计的方法与思路（关注接口的功能测试）

功能测试：验证接口功能是否按照接口文档实现（输入+处理+输出）

单接口测试：

正向功能：（通过性测试）

• 仅必填参数
• 全部参数
• 参数组合

反向测试：（异常测试）

• 参数异常：无参、少参、多参、错误参数
• 数据异常：数据为空、长度不符、类型不符、错误数据
• 业务数据异常：结合业务功能考虑输出的各种异常返回情况

多接口测试：业务场景功能测试（站在用户角度考虑常用的使用场景）

接口之间数据依赖

七、单接口测试：

针对人力资源管理系统的员工管理接口进行测试：

八、场景测试：

登录系统后，对员工进行增删改查的操作

今天这篇文章就到这里了，文底会有一些小练习大家可以抽空做下，在下篇文章的时候会把答案放在最后，大厦之成，非一木之材也；大海之阔，非一流之归也，希望大家能持续关注下，文章从浅入深，也欢迎大佬们的随时指导！！！

作业：

1、关于接口测试点设计，以下描述正确的有：

A：接口测试可以对单接口以及多个接口关联的业务场景进行测试。
B：接口测试可以对性能，安全等测试点进行测试。
C：接口测试用例需要对接口的请求参数进行设计，测试全部参数、组合参数、必填参数的正向测试；以及反向的多参、少参、无参、错误参数测试；
D：设计的接口测试用例，有部分会与手工测试用例重复。

2、关于接口用例的设计思路，以下描述正确的有：

A：可以对接口的参数进行测试，包括了异常的多参、少参、无参、错误参数和正向的必填参数，组合参数，全部参数。
B：可以对接口的数据进行测试，包括正确的数据和异常的数据。设计登陆接口的登陆成功案例和用户名中有特殊字符等案例。
C：可以对接口的依赖关系进行测试，如：业务系统需求设计为需要先登陆才能添加员工，那么我们可以设计正向的和反向的用例，分别测试登陆后添加员工和没有登陆时添加员工。
D：我们必须测试接口的域名错误场景，模拟域名不正确时，是否能正确调用接口。