Python接口自动化测试的学习笔记6——接口请求统一封装

1、前言

在进行Python接口自动化测试时，为了提高代码复用率、降低维护成本以及提升测试效率，我们常常会将HTTP请求的操作进行统一的封装。下面，让我们一起探索如何创建一个简洁且易于理解的Python请求封装方法。

2、接口请求统一封装

在前面文章中，已经使用过requests.get()、requests.post()、requests.request()，这些都是requests库里已经封装好的方法，虽然直接调用没什么问题，不过在实际项目中，接口数量多且类型复杂，再直接调用这些方法就不太够用了，所以我们直接自己去封装一个方法，可以适用于大多数的接口请求。

1）首先，我们在common目录下新建requests_util.py文件，创建一个基础的请求函数，该函数负责处理所有类型的HTTP请求，并返回响应结果

import requests


class RequestsUtil:

    def __init__(self):
        """session管理器"""
        # 实例化session
        self.session = requests.session()

    # 统一请求封装
    def send_request(self, method, url, headers=None, params=None, data=None, json=None, **kwargs):
        """
            统一封装HTTP请求方法
            :param method: 请求方法，如'GET', 'POST', 'PUT', 'DELETE'等
            :param url: 请求URL
            :param headers: 请求头信息，可选参数
            :param params: URL查询参数，适用于GET请求，可选参数
            :param data: 发送的数据，适用于POST等请求，可选参数
            :param json: 以json格式发送的数据，适用于POST等请求，可选参数
            :return: 返回requests库的Response对象
            """
        try:
            response = self.session.request(method, url, headers=headers, params=params, data=data, json=json, **kwargs)
            response.raise_for_status()  # 如果响应状态不是200系列，则抛出异常
            return response
        except requests.RequestException as e:
            print(f"请求发生错误: {e}")
            return None

2）接下来，我们去test_login.py调用下这个函数，再打印下响应状态码

import pytest

from config.requests_util import RequestsUtil
from common.yaml_util import YamlUtil


class TestLogin:
    @pytest.mark.parametrize('case_info', YamlUtil().read_testcases_yaml('login.yml'))
    def test_login(self, case_info):
        print('case_info：', case_info)
        url = case_info['request']['url']
        method = case_info['request']['method']
        json = case_info['request']['json']
        # requests.request请求
        res = RequestsUtil().send_request(url=url, method=method, json=json)
        # 获取返回结果数据，json格式接收
        response = res.json()
        # 打印返回结果到控制台
        print('返回结果：', response)
        # 打印服务器响应状态码
        print('服务器响应状态码：', res.status_code)

3）查看请求的返回结果

3、接口状态码断言

在上面我们可以看到，虽然第二个用例请求的返回结果显示失败了，可是打印出来的服务器响应码还是为200，这说明接口返回结果的状态码跟服务器响应状态码没对应上，那么现在不能看服务器响应状态码来判断这个接口是否请求通过了，我们可以拿接口返回的code来进行判断，使用assert进行简单的断言处理。

# 获取接口返回code
res_code = response['code']
assert res_code == 200, print('接口返回code为：', res_code, ',', '接口请求失败！')

查看执行后的结果，第二条用例执行不通过，这样我们就对接口响应做了简单的状态码断言。

4、总结

通过这种统一的请求封装方式，我们可以轻松地对不同HTTP方法的接口进行调用，同时也方便添加全局的错误处理逻辑和日志记录。随着项目的扩展和接口数量的增长，这种方式带来的好处将愈发明显。