Python + Pytest 接口自动化测试方案

Alan_752026-06-05 13:43

前言

Postman 仅适合单接口调试，面对批量回归、多环境验证和持续集成场景，手工操作效率极低且易出错。本文带你从零搭建一套企业级可落地的 Python + Pytest 接口自动化测试框架，覆盖接口封装、数据驱动、报告可视化、CI/CD 集成全流程，可直接用于小型项目，也可平滑扩展至大型分布式系统。

技术选型与优势对比

我们选择以下技术栈，兼顾易用性、扩展性和生态成熟度：

技术工具 核心作用 选型优势
Python 3.8+ 脚本开发语言 语法简洁、第三方库丰富、测试领域生态完善
Requests HTTP 请求发送 最流行的 HTTP 客户端，API 简单易用
Pytest 测试用例管理与执行 比 unittest 更灵活，支持参数化、fixture、插件扩展
Allure 测试报告生成 可视化效果好，支持用例分类、失败截图、历史趋势
YAML 测试数据与配置管理 可读性强，适合存储结构化数据
Jenkins 持续集成 开源免费，支持定时构建、代码触发、报告集成

标准化项目结构

采用分层设计思想，将配置、接口、用例、工具、数据分离，保证框架的可维护性：

bash 复制代码 
api_auto_test/
├── config/                 # 环境配置目录
│   └── config.yaml         # 多环境配置（开发/测试/生产）
├── api/                    # 接口封装层（所有业务接口）
│   ├── __init__.py
│   └── login_api.py        # 登录接口封装
├── testcases/              # 测试用例层（仅写用例逻辑）
│   ├── __init__.py
│   └── test_login.py       # 登录模块测试用例
├── utils/                  # 工具层（通用方法）
│   ├── __init__.py
│   ├── request_util.py     # HTTP 请求封装
│   ├── assert_util.py      # 统一断言工具
│   └── log_util.py         # 日志工具（可选）
├── data/                   # 测试数据层（数据驱动）
│   └── login_data.yaml     # 登录模块测试数据
├── reports/                # 测试报告输出目录
├── requirements.txt        # 项目依赖清单
└── pytest.ini              # Pytest 全局配置文件

环境搭建与依赖安装

1. 基础环境要求

  • Python 3.8 及以上版本
  • pip 包管理工具

2. 安装依赖包

执行以下命令一键安装所有依赖：

bash 复制代码 
pip install requests pytest pyyaml allure-pytest

3. 生成依赖清单

方便后续团队协作和 CI 集成：

bash 复制代码 
pip freeze > requirements.txt

核心模块实现

5.1 多环境配置管理

在 config/config.yaml 中配置多环境信息，支持一键切换：

yaml 复制代码 
# 环境配置：dev-开发环境 test-测试环境 prod-生产环境
active_env: "test"

env:
  dev:
    base_url: "https://dev-api.example.com"
    timeout: 10
  test:
    base_url: "https://api.example.com"
    timeout: 10
  prod:
    base_url: "https://prod-api.example.com"
    timeout: 15

5.2 通用请求工具封装

在 utils/request_util.py 中封装 HTTP 请求，增加异常处理和日志打印：

python 复制代码 
import requests
import yaml
import logging
from typing import Dict, Any

# 配置日志
logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s - %(levelname)s - %(message)s"
)
logger = logging.getLogger(__name__)

class RequestUtil:
    def __init__(self):
        # 加载配置文件
        with open("../config/config.yaml", "r", encoding="utf-8") as f:
            self.config = yaml.safe_load(f)
        # 获取当前激活的环境
        self.active_env = self.config["active_env"]
        self.base_url = self.config["env"][self.active_env]["base_url"]
        self.timeout = self.config["env"][self.active_env]["timeout"]

    def send_request(
        self,
        method: str,
        path: str,
        headers: Dict[str, str] = None,
        params: Dict[str, Any] = None,
        json: Dict[str, Any] = None,
        data: Any = None,
        **kwargs
    ) -> requests.Response:
        """
        统一发送 HTTP 请求
        :param method: 请求方法 GET/POST/PUT/DELETE
        :param path: 接口路径
        :param headers: 请求头
        :param params: URL 参数
        :param json: JSON 格式请求体
        :param data: 表单格式请求体
        :return: 响应对象
        """
        url = self.base_url + path
        logger.info(f"请求地址: {method} {url}")
        logger.info(f"请求参数: params={params}, json={json}")

        try:
            resp = requests.request(
                method=method,
                url=url,
                headers=headers,
                params=params,
                json=json,
                data=data,
                timeout=self.timeout,
                **kwargs
            )
            logger.info(f"响应状态码: {resp.status_code}")
            logger.info(f"响应内容: {resp.text[:500]}")  # 只打印前500字符，避免日志过长
            return resp
        except requests.exceptions.Timeout:
            logger.error(f"请求超时: {url}")
            raise
        except requests.exceptions.ConnectionError:
            logger.error(f"连接失败: {url}")
            raise
        except Exception as e:
            logger.error(f"请求异常: {str(e)}")
            raise

5.3 业务接口层封装

在 api/login_api.py 中封装登录接口，遵循一个接口一个方法的原则：

python 复制代码 
from utils.request_util import RequestUtil

class LoginApi:
    def __init__(self):
        self.request = RequestUtil()

    def login(self, username: str, password: str):
        """
        登录接口
        :param username: 用户名
        :param password: 密码
        :return: 响应对象
        """
        path = "/api/v1/login"
        payload = {
            "username": username,
            "password": password
        }
        return self.request.send_request(
            method="POST",
            path=path,
            json=payload
        )

5.4 数据驱动测试数据

在 data/login_data.yaml 中管理测试数据，实现数据与脚本分离：

yaml 复制代码 
- case_name: 正常登录-正确用户名密码
  username: "test01"
  password: "123456"
  expect_status: 200
  expect_code: 0
  expect_msg: "登录成功"

- case_name: 登录失败-密码错误
  username: "test01"
  password: "wrong123"
  expect_status: 200
  expect_code: 1001
  expect_msg: "密码错误"

- case_name: 登录失败-用户名不存在
  username: "nonexist"
  password: "123456"
  expect_status: 200
  expect_code: 1002
  expect_msg: "用户不存在"

- case_name: 登录失败-用户名为空
  username: ""
  password: "123456"
  expect_status: 200
  expect_code: 1003
  expect_msg: "用户名不能为空"

5.5 测试用例编写

在 testcases/test_login.py 中编写测试用例，使用 Pytest 参数化实现数据驱动：

python 复制代码 
import pytest
import yaml
from api.login_api import LoginApi

# 加载测试数据
def load_login_data():
    with open("../data/login_data.yaml", "r", encoding="utf-8") as f:
        return yaml.safe_load(f)

class TestLogin:
    def setup_class(self):
        """测试类执行前的初始化操作"""
        self.login_api = LoginApi()

    @pytest.mark.parametrize("case", load_login_data(), ids=[case["case_name"] for case in load_login_data()])
    def test_login_cases(self, case):
        """登录接口测试用例"""
        # 发送请求
        resp = self.login_api.login(
            username=case["username"],
            password=case["password"]
        )
        # 断言
        assert resp.status_code == case["expect_status"]
        assert resp.json()["code"] == case["expect_code"]
        assert case["expect_msg"] in resp.json()["msg"]

5.6 统一断言工具

在 utils/assert_util.py 中封装常用断言方法，统一断言逻辑：

python 复制代码 
import requests
from typing import Any

def assert_status_code(resp: requests.Response, expect_code: int = 200):
    """断言响应状态码"""
    assert resp.status_code == expect_code, f"状态码错误，预期：{expect_code}，实际：{resp.status_code}"

def assert_response_code(resp: requests.Response, expect_code: int = 0):
    """断言业务响应码"""
    assert resp.json()["code"] == expect_code, f"业务码错误，预期：{expect_code}，实际：{resp.json()['code']}"

def assert_response_contains(resp: requests.Response, key: str, value: Any):
    """断言响应体包含指定键值对"""
    assert key in resp.json(), f"响应体中不存在键：{key}"
    assert resp.json()[key] == value, f"键值错误，预期：{value}，实际：{resp.json()[key]}"

def assert_response_msg_contains(resp: requests.Response, expect_msg: str):
    """断言响应消息包含指定内容"""
    assert expect_msg in resp.json()["msg"], f"响应消息不包含：{expect_msg}，实际：{resp.json()['msg']}"

测试执行与报告生成

1. 基础执行命令

在项目根目录执行以下命令运行所有测试用例：

bash 复制代码 
pytest -v

2. 生成 Allure 测试报告

bash 复制代码 
# 执行测试并生成 Allure 原始数据
pytest -v --alluredir=reports/allure-results

# 启动本地服务查看报告
allure serve reports/allure-results

# 生成静态 HTML 报告（可部署到服务器）
allure generate reports/allure-results -o reports/allure-report --clean

Pytest 全局配置

在 pytest.ini 中配置 Pytest 全局参数，简化执行命令：

ini 复制代码 
[pytest]
# 默认命令行参数：-s 输出print信息 --tb=short 简化错误堆栈
addopts = -s --tb=short --alluredir=reports/allure-results
# 指定测试用例搜索路径
testpaths = testcases
# 指定测试文件命名规则
python_files = test_*.py
# 指定测试类命名规则
python_classes = Test*
# 指定测试方法命名规则
python_functions = test_*
# 标记用例（用于分组执行）
markers =
    smoke: 冒烟测试用例
    regression: 回归测试用例

Jenkins CI/CD 持续集成

将框架集成到 Jenkins，实现代码提交自动触发测试 和定时回归测试：

  1. 安装插件 ：在 Jenkins 插件管理中安装 Allure Plugin、Git Plugin

  2. 新建自由风格项目

  3. 配置源码管理：填写 Git 仓库地址和分支

  4. 添加构建步骤 ：执行 Shell 命令

    bash 复制代码 
    # 安装依赖
pip install -r requirements.txt
# 执行测试
pytest

  5. 配置构建后操作 ：添加 Allure Report，指定报告路径为 reports/allure-results

  6. 可选配置 ：

    • 构建触发器：设置定时构建（如每天凌晨 2 点执行回归测试）
    • 构建通知：配置邮件通知，构建失败时发送邮件给相关人员

常见问题 FAQ

  1. Allure 安装失败怎么办？

    • Windows：下载 Allure 二进制包，解压后将 bin 目录添加到系统环境变量
    • Mac：执行 brew install allure
    • Linux：执行 sudo apt install allure

  2. 运行用例提示文件路径错误？

    • 确保在项目根目录执行 pytest 命令
    • 将相对路径改为绝对路径，或使用 os.path 模块动态获取路径

  3. 中文乱码问题？

    • 在打开文件时指定 encoding="utf-8"
    • 在 pytest.ini 中添加 env = LANG=zh_CN.UTF-8

  4. 如何处理需要 Token 的接口？

    • 将登录获取 Token 的操作封装为 Fixture，在需要的用例中引用
    • 将 Token 保存到全局变量或配置文件中，供后续接口使用

结语

接口自动化不是简单的"写脚本"，而是构建一套可持续维护、可扩展、可集成的质量保障体系。本文提供的方案是一个基础框架，你可以根据项目实际需求进行扩展，比如增加数据库操作、接口签名、文件上传下载等功能。

相关推荐
m0_5358175518 小时前
Mac下Claude Code完整配置指南：API中转+环境变量设置一步到位
gpt·macos·node.js·api·claude·claudecode·88api
m0_535817551 天前
macOS下Claude Code从0到1配置教程（附API密钥获取+常见报错修复）
gpt·macos·node.js·api·claude·claudecode·88api
halazi1001 天前
如何在华为云上开通MaaS服务并创建API Key，并在CodeArts Agent中配置使用API Key
华为云·api·tokens
壹方秘境2 天前
iOS抓包新选择：ApiCatcher同时支持捕获HTTP(s)和WebSocket(s)协议数据包
websocket·ios·api
147API3 天前
API 中转站怎么选？先看 Claude 和 GPT 能不能接明白API 中转站怎么选？先看 Claude 和 GPT 能不能接明白
api·api接入
Resistance丶未来3 天前
Pixelle-Video：AI全自动短视频引擎 接入API教程
人工智能·大模型·api·claude·deepseek·魔芋ai·pixelle-video
147API3 天前
n8n 接入第三方 API 教程：在工作流里调用大模型
api·api中转·n8n·api接入
柒和远方3 天前
每日一学V012: 从 Python 到 Node.js：一个 AI Native 开发者的 JavaScript 调用 LLM 实战
javascript·node.js·api
cup114 天前
[Full Clock 技术复盘] 一、浏览器前端如何实现百毫秒级时间校准？时间 API 推荐、模拟 NTP 算法原理及局限
typescript·开源·api·时钟·时间同步
热门推荐
01GitHub 镜像站点02Codex 下载安装指南：Windows 和 macOS 官方版下载03【AI】2026 年具身智能模型和世界模型总结042026 年 AI 编程工具终极横评：Cursor vs Claude Code vs Copilot vs Windsurf05Codex 桌面端更新后 Chrome 插件和 Computer Use 不可用，怎么排查和修复06【踩坑记录 | 第一篇】微软商店无法使用时，如何手动安装 OpenAI Codex？附`.msix`文件系统错误解决方法07CC-Switch 下载、安装与使用配置指南【2026.5.29】08Codex 接入 DeepSeek API 完整配置文档09CC-Switch & Claude 基于 Linux 服务器安装使用指南10裂开！ChatGPT 居然开始要手机号验证，附详细解决方法