Python脚本API自动化测试如何写

Python脚本API自动化测试实战指南：从零搭建高效测试框架

文章导读目录

1. 为什么选择Python进行API自动化测试？
2. API测试基础与核心概念
3. 环境搭建：工具与库的安装
4. 实战：编写第一个API测试脚本
5. 进阶：数据驱动与参数化测试
6. 测试报告与持续集成
7. 常见问题与最佳实践（含问答）
8. 总结与学习资源

为什么选择Python进行API自动化测试？

在互联网应用高速迭代的今天,API作为系统间通信的桥梁，其稳定性和正确性直接决定产品质量，根据Stack Overflow 2024开发者调查，Python连续五年成为最受欢迎的测试脚本语言，原因有三：

• 语法简洁：Python的伪代码特性让测试逻辑清晰可读
• 生态丰富：requests、pytest、allure等库覆盖HTTP请求到报告生成全流程
• 与DevOps无缝集成：支持Jenkins、GitLab CI等主流CI/CD工具

核心价值：相比手动测试，自动化脚本可在5分钟内完成300个API端点的回归测试，错误发现率提升80%。

API测试基础与核心概念

1 HTTP协议三要素

• 请求方法：GET（查）、POST（增）、PUT（改）、DELETE（删）
• 状态码：200（成功）、4xx（客户端错误）、5xx（服务端错误）
• 请求/响应结构：Header（认证信息）、Body（JSON/XML数据）

2 测试类型

环境搭建：工具与库的安装

# 安装核心库
pip install requests pytest pytest-html allure-pytest
# 验证安装
python -c "import requests; print('OK')"

推荐开发工具：

• PyCharm Community（免费）
• VS Code + Python插件
• Postman（用于手动验证后再编写脚本）

实战：编写第一个API测试脚本

1 基础GET请求测试

import requests
def test_get_user():
    url = "https://api.example.com/users/1"
    headers = {"Authorization": "Bearer token123"}
    response = requests.get(url, headers=headers)
    # 断言
    assert response.status_code == 200
    assert response.json()["name"] == "张三"
    print("测试通过！")

2 POST请求与数据驱动

def test_create_user():
    url = "https://api.example.com/users"
    payload = {
        "name": "李四",
        "email": "lisi@example.com"
    }
    response = requests.post(url, json=payload)
    assert response.status_code == 201
    assert response.json()["id"] > 0

进阶：数据驱动与参数化测试

使用pytest.mark.parametrize实现多场景覆盖：

import pytest
import requests
test_data = [
    ("正常用户", {"name": "王五", "age": 25}, 201),
    ("年龄为0", {"name": "赵六", "age": 0}, 400),
    ("缺失姓名", {"age": 30}, 422),
]
@pytest.mark.parametrize("case_name, payload, expected_status", test_data)
def test_user_creation(case_name, payload, expected_status):
    response = requests.post("https://api.example.com/users", json=payload)
    assert response.status_code == expected_status, f"用例{case_name}失败"

优势：一行代码覆盖3个测试用例，新增测试只需扩展test_data列表。

测试报告与持续集成

1 生成精美HTML报告

pytest test_api.py --html=report.html --self-contained-html

2 集成Allure框架（更专业的报告）

pytest --alluredir=./allure-results
allure serve ./allure-results

3 Jenkins配置步骤

1. 将脚本提交到Git仓库
2. Jenkins中创建自由风格项目
3. 构建触发器选择“轮询SCM”
4. 构建步骤添加“Execute Shell”：

   pip install -r requirements.txt
   pytest test_api.py --junitxml=result.xml

5. 构建后操作添加“Publish JUnit test result report”

常见问题与最佳实践（含问答）

Q1: 如何处理API认证token动态获取？

A：使用requests.Session自动携带cookie，或用pytest.fixture实现前置登录：

@pytest.fixture(scope="session")
def auth_token():
    login_resp = requests.post("https://api.example.com/login", json={"user": "admin", "pass": "123"})
    return login_resp.json()["token"]
def test_get_data(auth_token):
    headers = {"Authorization": f"Bearer {auth_token}"}
    response = requests.get("https://api.example.com/data", headers=headers)
    assert response.status_code == 200

Q2: 接口返回的数据结构复杂，如何快速验证？

A：使用jsonschema库进行模式验证：

from jsonschema import validate
schema = {
    "type": "object",
    "properties": {
        "id": {"type": "integer"},
        "email": {"type": "string", "format": "email"}
    },
    "required": ["id", "email"]
}
response_data = response.json()
validate(instance=response_data, schema=schema)

Q3: 测试环境不稳定导致频繁失败怎么办？

A：实施重试机制：

@pytest.mark.flaky(reruns=3, reruns_delay=2)
def test_unstable_api():
    response = requests.get("https://unstable-api.example.com")
    assert response.status_code == 200

Q4: 如何管理测试数据文件（如CSV/JSON）？

A：使用pandas读取外部数据：

import pandas as pd
data = pd.read_csv("test_data.csv")
for _, row in data.iterrows():
    yield (row["name"], row["expected_status"])

总结与学习资源

最佳实践清单

• ✅ 每个测试用例独立可运行，不依赖其他用例
• ✅ 使用requests.Session管理连接池（提升30%性能）
• ✅ 敏感信息（密码/token）写入环境变量，不硬编码
• ✅ 每个API测试包含：状态码 + 关键字段 + 结构验证
• ✅ 定期运行测试并维护test_data.csv

推荐学习路径

1. 官方文档：requests库文档、pytest文档
2. 书籍：《Python自动化测试实战》
3. 视频教程：B站搜索“API自动化测试 从入门到项目实战”
4. 练习平台：https://jsonplaceholder.typicode.com（免费测试API）

附录：完整项目结构示例

api_test_project/
├── config/
│   └── settings.py          # 环境配置
├── data/
│   └── test_data.json       # 测试数据
├── tests/
│   ├── test_user_api.py     # 用户相关接口
│   ├── test_order_api.py    # 订单接口
│   └── conftest.py          # 共享fixture
├── reports/                 # 测试报告输出
├── requirements.txt         # 依赖清单
└── pytest.ini               # 配置文件

创建这样一个结构清晰的自动化测试框架后,您将能够：

• 每天定时运行500+ API测试用例
• 在新版本上线前15分钟完成全量回归
• 测试报告直接关联到缺陷管理系统

现在就开始行动,从第一个assert response.status_code == 200开始，构建属于您的API质量防线。