软件测试笔记｜接口自动化测试｜接口自动化测试框架封装之统一请求封装

“动动小手，点点关注呗～”

在接口自动化测试中，随着测试用例数量的增加和接口的复杂性提高，如何高效地管理和执行接口请求成为一个关键问题。

统一请求封装作为接口自动化测试框架的重要组成部分，能够显著提高测试代码的可维护性、可读性和复用性。

本文将深入探讨接口自动化测试框架中统一请求封装的概念、原理、优势，并通过具体代码示例展示其在不同场景下的应用。

一、统一请求封装的概念与原理

（一）概念

统一请求封装是指将接口请求的通用操作和逻辑进行抽象和封装，形成一个统一的接口请求方法或类。这个封装层隐藏了底层 HTTP 请求库（如 Requests 库）的复杂性，为测试用例提供了简单、一致的接口调用方式。

（二）原理

通过封装，我们可以在一个地方处理请求的基本设置，如请求头、请求参数、请求方法等。同时，还可以在封装层中加入异常处理、日志记录、请求重试等功能，使得测试用例在调用接口时无需关注这些细节，只需提供必要的接口参数即可。

二、统一请求封装的优势

（一）提高代码可维护性

当接口发生变化时，如请求地址、请求参数格式改变，只需要在统一请求封装层进行修改，而无需在每个测试用例中逐个查找和修改，大大降低了维护成本。

（二）增强代码可读性

测试用例中调用统一封装的接口请求方法，代码逻辑更加清晰，易于理解测试用例的意图，提高了代码的可读性，方便团队成员之间的协作和代码审查。

（三）实现代码复用

对于不同的测试用例，如果涉及到相同的接口请求，可直接复用统一封装的方法，避免了重复编写相同的请求代码，提高了开发效率。

（四）便于功能扩展

在统一请求封装层可以方便地添加新的功能，如身份验证、接口加密、请求缓存等，而不会影响到现有的测试用例。

三、统一请求封装的代码实现及使用场景

（一）使用 Python 的 Requests 库进行基本封装

首先，创建一个api_request.py文件，用于封装接口请求相关代码。

import requests# 定义基础URLBASE_URL = "http://your_api_base_url"def api_request(method, endpoint, **kwargs):   url = BASE_URL + endpoint   try:       if method == "GET":           response = requests.get(url, **kwargs)       elif method == "POST":           response = requests.post(url, **kwargs)       elif method == "PUT":           response = requests.put(url, **kwargs)       elif method == "DELETE":           response = requests.delete(url, **kwargs)       else:           raise ValueError(f"不支持的请求方法: {method}")       response.raise_for_status()       return response.json()   except requests.exceptions.RequestException as e:       print(f"接口请求出错: {e}")       return None

使用场景示例

场景一：查询用户信息接口

假设我们有一个查询用户信息的接口，接口地址为/users/{user_id}，使用 GET 方法请求。

在测试用例文件test_user.py中，可以这样调用封装好的接口请求方法：

from api_request import api_requestdef test_get_user_info():   user_id = 123   endpoint = f"/users/{user_id}"   response_data = api_request("GET", endpoint)   assert response_data["name"] == "张三"  # 假设查询到的用户名为张三

场景二：创建用户接口

创建用户接口地址为/users，使用 POST 方法，需要传递用户数据（如姓名、年龄等）作为请求体。

from api_request import api_requestdef test_create_user():   user_data = {"name": "李四", "age": 25}   endpoint = "/users"   response_data = api_request("POST", endpoint, json=user_data)   assert response_data["message"] == "用户创建成功"

（二）在封装中加入请求头处理

扩展api_request.py文件，加入请求头处理功能。

import requestsBASE_URL = "http://your_api_base_url"def api_request(method, endpoint, headers=None, **kwargs):   url = BASE_URL + endpoint   if headers is None:       headers = {}   try:       if method == "GET":           response = requests.get(url, headers=headers, **kwargs)       elif method == "POST":           response = requests.post(url, headers=headers, **kwargs)       elif method == "PUT":           response = requests.put(url, headers=headers, **kwargs)       elif method == "DELETE":           response = requests.delete(url, headers=headers, **kwargs)       else:           raise ValueError(f"不支持的请求方法: {method}")       response.raise_for_status()       return response.json()   except requests.exceptions.RequestException as e:       print(f"接口请求出错: {e}")       return None

使用场景示例

场景三：需要身份验证的接口请求

有些接口需要在请求头中传递身份验证信息，如Authorization字段。

from api_request import api_requestdef test_authenticated_api():   access_token = "your_access_token"   headers = {"Authorization": f"Bearer {access_token}"}   endpoint = "/protected_resource"   response_data = api_request("GET", endpoint, headers=headers)   assert response_data["is_authorized"] == True

（三）封装中加入日志记录功能

使用 Python 的logging模块，在api_request.py中添加日志记录。使用场景示例

在任何接口请求时，都会记录请求的详细信息和响应结果，方便调试和问题排查。例如在上述查询用户信息和创建用户的测试用例中，每次请求都会在控制台输出相应的日志信息。

（四）封装中加入请求重试功能

使用场景示例

场景四：网络不稳定情况下的接口请求

在网络环境不稳定时，接口请求可能会偶尔失败。通过请求重试功能，当遇到请求失败时，会自动重试一定次数（这里设置为 3 次，每次重试间隔 2 秒）。例如在查询用户信息接口测试中，如果由于网络波动导致第一次请求失败，封装层会自动进行重试，直到请求成功或达到重试次数上限。

使用retry库（需要先安装）来实现请求重试功能，修改文件。通过以上对接口自动化测试框架中统一请求封装的详细介绍，我们可以看到其在提高测试效率、降低维护成本和增强代码质量等方面的重要作用。在实际的接口自动化测试项目中，根据项目需求合理运用统一请求封装技术，能够使测试工作更加高效、可靠。希望本文能为从事接口自动化测试的读者提供有价值的参考和帮助。