Python接口自动化测试框架搭建:Requests+Pytest+Allure实战

Theo
Theo
发布时间:2026-11-17| 5人浏览过
原创

本文详细讲解如何使用 Python、Requests、Pytest 与 Allure 从零搭建企业级接口自动化测试框架,涵盖分层架构设计、环境配置、Session封装、数据驱动与测试报告生成全流程。

搭建一套高效且可维护的接口自动化测试框架,核心在于通过清晰的职责分层,将“网络请求、测试逻辑组织、用例数据管理和执行结果呈现”解耦。本文将以业内广泛采用的 Requests + Pytest + Allure 技术栈为主线,从环境准备、目录分层、客户端封装、夹具驱动到测试报告输出,完整演示生产级接口自动化框架的落地过程与关键实现细节。

一、技术架构与职责分工

在开始编写代码前,我们需要理清三个核心组件的分工协作关系。Requests 负责底层 HTTP 协议的通信与会话保持;Pytest 提供灵活的夹具系统(Fixture)、断言机制以及测试用例的筛选与批量调度;Allure 则接入测试执行生命周期,收集步骤描述、请求响应明细与失败截图,最终渲染出结构清晰的交互式可视化报告。

Python接口自动化测试框架搭建:Requests+Pytest+Allure实战
图 1:Requests+Pytest+Allure 核心架构与职责分工

二、环境依赖与目录结构设计

搭建工程首先需确立清晰的目录规范。通过把配置、网络请求、测试用例与测试数据分离,能够避免单一脚本膨胀导致的维护灾难。

1. 依赖库配置

在工程根目录创建 requirements.txt,写入核心依赖库:

pytest>=7.4.0
requests>=2.31.0
allure-pytest>=2.13.0
pyyaml>=6.0.1

在命令行执行安装命令:

pip install -r requirements.txt

注意:allure-pytest 仅是 Pytest 收集用例执行结果的适配插件。生成最终的 HTML 网页报告还需要操作系统安装独立的 Allure CLI 命令行工具(可通过 Homebrew、Scoop 或官方二进制压缩包解压配置到 PATH 中)。

2. 推荐的标准工程目录

api_test_framework/
│
├── config/             # 运行配置(环境URL、超时设置等)
│   └── setting.py
├── core/               # 框架核心驱动(Session客户端封装、请求日志)
│   ├── __init__.py
│   └── client.py
├── api/                # 接口对象层(API Object,按业务模块封装接口请求)
│   ├── __init__.py
│   └── user_api.py
├── data/               # 测试数据文件
│   └── user_data.yaml
├── test_cases/         # 实际测试用例目录
│   ├── conftest.py     # Pytest 夹具配置文件
│   └── test_user.py    # 业务接口测试用例
├── pytest.ini          # Pytest 全局行为配置文件
└── requirements.txt    # 项目依赖清单

三、核心底层封装:网络通信与会话管理

直接在用例中裸写 requests.get() 或 requests.post() 会导致大量重复的请求头设置、Token 传递以及异常处理代码。我们需要通过继承或包装 requests.Session 实现统一请求客户端。

1. 封装 HTTP 客户端 (core/client.py)

在该模块中,我们统一管理请求超时、公共 Header、自动记录日志,并将关键请求参数挂载至 Allure 附件中,以便在报告中随时审查入参与响应体。

import requests
import json
import allure

class HttpClient:
    def __init__(self, base_url="", timeout=10):
        self.base_url = base_url.rstrip("/")
        self.timeout = timeout
        self.session = requests.Session()

    def set_header(self, key, value):
        self.session.headers[key] = value

    def request(self, method, endpoint, **kwargs):
        url = f"{self.base_url}/{endpoint.lstrip('/')}" if self.base_url else endpoint
        kwargs.setdefault("timeout", self.timeout)

        # 记录请求信息至 Allure 报告
        with allure.step(f"发送 HTTP {method.upper()} 请求: {endpoint}"):
            allure.attach(
                json.dumps(kwargs.get("json", kwargs.get("data", {})), ensure_ascii=False, indent=2),
                name="请求参数",
                attachment_type=allure.attachment_type.JSON
            )
            
            response = self.session.request(method=method, url=url, **kwargs)
            
            # 记录响应结果至 Allure 报告
            allure.attach(
                f"Status: {response.status_code}\n\n{response.text}",
                name="接口响应",
                attachment_type=allure.attachment_type.TEXT
            )
            return response

    def get(self, endpoint, **kwargs):
        return self.request("GET", endpoint, **kwargs)

    def post(self, endpoint, **kwargs):
        return self.request("POST", endpoint, **kwargs)

四、业务接口抽象:API Object 模式

与 UI 自动化的 Page Object 类似,接口自动化中应采用 API Object 模式。每个业务模块(如用户中心、商品模块)封装为一个 Python 类,测试用例只与接口类交互,不直接接触拼接的 URL。

1. 编写用户接口封装 (api/user_api.py)

from core.client import HttpClient

class UserApi:
    def __init__(self, client: HttpClient):
        self.client = client

    def login(self, username, password):
        payload = {"username": username, "password": password}
        return self.client.post("/api/v1/auth/login", json=payload)

    def get_user_profile(self, user_id):
        return self.client.get(f"/api/v1/users/{user_id}")

五、执行流程与 Pytest 夹具 (Fixture) 驱动

接口自动化中最常见的流程依赖是“登录后获取 Token,并在后续所有业务请求中携带”。Pytest 强大的 fixture 机制可优雅地解决依赖生命周期问题。

Python接口自动化测试框架搭建:Requests+Pytest+Allure实战
图 2:测试执行全流程步骤及夹具上下文流转

1. 编写夹具 (test_cases/conftest.py)

import pytest
from core.client import HttpClient
from api.user_api import UserApi

@pytest.fixture(scope="session")
def base_client():
    # 初始化全局基础 Client
    client = HttpClient(base_url="https://api.example.com")
    return client

@pytest.fixture(scope="session")
def auth_client(base_client):
    # 前置步骤:登录并设置统一授权请求头
    user_api = UserApi(base_client)
    res = user_api.login("admin_user", "secure_password_123")
    assert res.status_code == 200, "前置依赖:用户登录失败"
    token = res.json().get("token")
    base_client.set_header("Authorization", f"Bearer {token}")
    
    yield base_client
    
    # 后置清理操作(如注销登录)
    # base_client.post("/api/v1/auth/logout")

六、测试用例编写与 Allure 标注实战

通过 Allure 提供的注解(@allure.feature、@allure.story、@allure.step),可将技术代码转化为可读性极高的测试文档。

1. 编写测试用例 (test_cases/test_user.py)

import pytest
import allure
from api.user_api import UserApi

@allure.epic("核心业务接口测试")
@allure.feature("用户中心模块")
class TestUserModule:

    @allure.story("用户基本信息查询")
    @allure.title("有效用户 ID 查询接口校验")
    @allure.severity(allure.severity_level.CRITICAL)
    def test_get_user_success(self, auth_client):
        user_api = UserApi(auth_client)
        
        with allure.step("1. 调用查询用户信息接口"):
            resp = user_api.get_user_profile(user_id=1001)

        with allure.step("2. 校验 HTTP 响应状态码"):
            assert resp.status_code == 200

        with allure.step("3. 校验关键字段业务返回值"):
            data = resp.json()
            assert data["id"] == 1001
            assert data["status"] == "active"
            assert "email" in data

    @allure.story("用户基本信息查询")
    @allure.title("非法用户 ID 边界异常校验")
    @pytest.mark.parametrize("invalid_id, expected_code", [
        (-1, 400),
        (99999999, 404),
        ("abc", 400)
    ])
    def test_get_user_invalid(self, auth_client, invalid_id, expected_code):
        user_api = UserApi(auth_client)
        resp = user_api.get_user_profile(user_id=invalid_id)
        assert resp.status_code == expected_code

七、测试执行与 Allure 报告生成

在项目根目录创建 pytest.ini,配置测试用例匹配规则与默认执行参数:

[pytest]
testpaths = test_cases
python_files = test_*.py
python_classes = Test*
python_functions = test_*
addopts = -vs --alluredir=./allure-results --clean-alluredir

1. 运行测试并收集原始数据

在终端项目根目录下执行 Pytest:

pytest

命令运行后,终端将输出测试通过情况,并在 ./allure-results 目录下生成包含测试运行数据的 JSON 文件及附件。

2. 渲染并查看 Allure HTML 报告

使用 Allure CLI 将原始数据转化为 HTML 报表:

# 方式一:启动本地内置 Web 服务器直接预览报告
allure serve ./allure-results

# 方式二:生成独立的静态 HTML 网页发布至 CI/CD
allure generate ./allure-results -o ./allure-report --clean
allure open ./allure-report

八、方案对比:轻量封装 vs 引入复杂框架

许多团队在初期容易陷入“自研大而全框架”或“直接引入商业平台”的误区。下表梳理了纯 Requests+Pytest+Allure 原生轻量组合与传统重型测试平台的差异特征:

Python接口自动化测试框架搭建:Requests+Pytest+Allure实战
图 3:代码驱动框架与平台化工具特性对比

九、落地总结与最佳实践建议

通过上述步骤,我们完成了从通信封装、用例编写到测试报告呈现的全套接口自动化框架搭建。在实际企业级推广中,建议团队遵循以下三项落地准则:

  1. 坚决推行 API Object 抽象:严禁在测试用例方法内部硬编码接口 URL 和请求格式。一旦接口路径变动,只需修改 api/ 对应类,无需翻修数百条用例。
  2. 用例保持独立与幂等:每个测试用例应尽量自闭环,避免形成长链条的用例间数据强耦合。若必须依赖公共数据,通过 fixture 在当前用例执行前后完成构造与销毁。
  3. 报告信息适量记录:在生产级大批量用例运行中,只将关键字段或失败用例的完整报文挂载至 Allure 附件,避免测试结果目录产生几十吉字节的冗余 HTML/JSON 缓存。
Python接口自动化测试框架搭建:Requests+Pytest+Allure实战
图 4:接口自动化工程实施全景与避坑总结
相关专题:

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。