3分钟上手Playwright Python：API自动化测试从入门到实战
项目地址: https://gitcode.com/GitHub_Trending/pl/playwright-python 你是否还在为API测试工具配置复杂而烦恼？是否在寻找一个既能处理HTTP请求又能集成浏览器自动化的全能解决方案？本文将带你3分钟入门Playwright Python的API测试功能，从环境搭建到实战案例，让你快速掌握RESTful API自动化验证的核心技巧。读完本文后，你将能够独立编写API测试脚本、处理认证授权、验证响应数据，并集成到你的测试流程中。
为什么选择Playwright Python进行API测试
Playwright作为微软开源的自动化测试工具，不仅提供了强大的浏览器自动化能力，还内置了专门的API测试模块。与传统的API测试工具相比，它具有以下优势：
- 一体化解决方案：无需同时维护UI测试和API测试两套工具链
- 强大的请求处理：支持所有HTTP方法，自动处理JSON序列化和解析
- 灵活的认证机制：内置Cookie管理、HTTP认证、Token认证等多种方式
- 详细的响应验证：可以轻松获取状态码、响应头、响应体等完整信息
- 与浏览器测试无缝集成：API测试和UI测试可以共享上下文，实现端到端测试
API测试核心功能由playwright/_impl/_fetch.py模块提供，该模块定义了APIRequest和APIRequestContext等关键类，为API测试提供了坚实的基础。
环境准备与快速开始
安装Playwright Python
首先确保你的环境中已安装Python 3.7或更高版本，然后通过pip安装Playwright：
pip install playwright
playwright install
第二条命令会自动安装所需的浏览器驱动，虽然我们主要使用API测试功能，但这一步是必要的。
第一个API测试脚本
创建一个简单的API测试脚本，验证JSONPlaceholder的示例API：
from playwright.sync_api import sync_playwright
def test_api_basics():
with sync_playwright() as p:
# 创建API请求上下文
api_context = p.request.new_context(base_url="https://jsonplaceholder.typicode.com")
# 发送GET请求
response = api_context.get("/todos/1")
# 验证响应状态码
assert response.status == 200, f"Expected status 200, got {response.status}"
# 解析JSON响应
todo = response.json()
# 验证响应内容
assert todo["userId"] == 1, "User ID mismatch"
assert todo["title"] == "delectus aut autem", "Title mismatch"
print("API test passed!")
if __name__ == "__main__":
test_api_basics()
这个简单的脚本展示了Playwright API测试的基本流程：创建上下文、发送请求、验证响应。完整的API请求接口定义可以在playwright/sync_api/_generated.py中找到，该文件包含了所有同步API的类型定义。
API测试核心功能详解
请求方法与参数处理
Playwright支持所有常用的HTTP方法，包括GET、POST、PUT、DELETE等。这些方法通过APIRequestContext对象提供，如playwright/sync_api/_generated.py中定义的：
class APIRequestContext:
def get(self, url: str, **kwargs) -> APIResponse: ...
def post(self, url: str, **kwargs) -> APIResponse: ...
def put(self, url: str, **kwargs) -> APIResponse: ...
def delete(self, url: str, **kwargs) -> APIResponse: ...
# 更多方法...
发送POST请求并附带JSON数据的示例：
# 发送POST请求创建新资源
new_todo = {
"userId": 1,
"title": "Learn Playwright API testing",
"completed": False
}
response = api_context.post(
"/todos",
json=new_todo, # 自动序列化为JSON并设置Content-Type头
headers={"Authorization": "Bearer YOUR_TOKEN"}
)
assert response.status == 201, "Failed to create todo"
created_todo = response.json()
assert created_todo["title"] == new_todo["title"]
响应验证与错误处理
Playwright提供了丰富的响应验证方式。除了直接检查状态码和响应内容外，还可以使用断言API进行更复杂的验证：
# 验证响应状态码
assert response.ok, f"Request failed with status {response.status}"
# 获取响应头
content_type = response.headers["content-type"]
assert "application/json" in content_type, "Expected JSON response"
# 处理错误响应
if not response.ok:
error_details = response.json()
print(f"API Error: {error_details}")
# 可以在这里添加更复杂的错误处理逻辑
响应对象的详细定义在playwright/sync_api/_generated.py的Response类中，包含了获取响应头、状态码、响应体等方法。
认证与授权处理
Playwright支持多种认证方式，包括HTTP基本认证、Bearer Token、Cookie认证等：
# HTTP基本认证
api_context = p.request.new_context(
http_credentials={"username": "user", "password": "pass"}
)
# Bearer Token认证
api_context = p.request.new_context(
extra_http_headers={"Authorization": "Bearer YOUR_TOKEN"}
)
# Cookie认证
# 先通过登录API获取Cookie，然后在后续请求中自动携带
在tests/async/test_fetch_global.py中可以找到更多认证相关的测试案例，例如HTTP基本认证的测试：
async def test_should_work_with_correct_credentials_and_matching_origin(
playwright: Playwright, server: Server
) -> None:
server.set_auth("/empty.html", "user", "pass")
request = await playwright.request.new_context(
http_credentials={
"username": "user",
"password": "pass",
"origin": server.PREFIX,
}
)
response = await request.get(server.EMPTY_PAGE)
assert response.status == 200
请求拦截与模拟
Playwright允许你拦截和修改请求，这对于测试错误处理、模拟后端响应等场景非常有用：
def test_mock_api_response():
with sync_playwright() as p:
api_context = p.request.new_context(base_url="https://jsonplaceholder.typicode.com")
# 拦截所有对/todos的请求
def handle_route(route):
# 模拟响应
route.fulfill(
status=200,
content_type="application/json",
body=json.dumps([{"id": 1, "title": "Mocked todo"}])
)
api_context.route("/todos", handle_route)
# 发送请求，将被拦截并返回模拟响应
response = api_context.get("/todos")
todos = response.json()
assert len(todos) == 1
assert todos[0]["title"] == "Mocked todo"
高级功能与最佳实践
测试数据管理
对于更复杂的测试场景，建议将测试数据与测试逻辑分离：
import json
def load_test_data(file_path):
with open(file_path, "r") as f:
return json.load(f)
def test_with_external_data():
test_data = load_test_data("api_test_data.json")
with sync_playwright() as p:
api_context = p.request.new_context(base_url=test_data["base_url"])
for test_case in test_data["test_cases"]:
response = api_context.request(test_case["method"],
test_case["endpoint"],
data=test_case.get("data"))
assert response.status == test_case["expected_status"], \
f"Test failed for {test_case['name']}"
报告与集成
Playwright可以与pytest等测试框架集成，生成详细的测试报告：
# test_api.py
import pytest
from playwright.sync_api import sync_playwright
@pytest.fixture(scope="module")
def api_context():
with sync_playwright() as p:
yield p.request.new_context(base_url="https://jsonplaceholder.typicode.com")
def test_get_todo(api_context):
response = api_context.get("/todos/1")
assert response.status == 200
todo = response.json()
assert todo["id"] == 1
def test_create_todo(api_context):
new_todo = {"title": "Test todo", "completed": False}
response = api_context.post("/todos", json=new_todo)
assert response.status == 201
然后使用pytest运行测试并生成报告：
pytest test_api.py -v --html=api_test_report.html
性能与可靠性优化
为了提高API测试的性能和可靠性，可以采用以下最佳实践：
- 复用请求上下文：避免为每个测试创建新的上下文
- 设置合理的超时：根据API响应时间调整超时设置
- 处理重试逻辑：利用Playwright的重试机制处理临时故障
- 并行执行测试：使用pytest-xdist等工具并行运行测试
# 设置超时和重试
api_context = p.request.new_context(
timeout=30000, # 30秒超时
max_retries=2 # 最多重试2次
)
实战案例：完整的API测试流程
下面是一个完整的API测试案例，涵盖了从创建资源到删除资源的整个流程：
def test_api_crud_operations():
with sync_playwright() as p:
base_url = "https://jsonplaceholder.typicode.com"
api_context = p.request.new_context(base_url=base_url)
# 1. 创建新资源
new_post = {
"title": "Playwright API Test",
"body": "This is a test post created with Playwright",
"userId": 1
}
create_response = api_context.post("/posts", json=new_post)
assert create_response.status == 201, "Failed to create post"
created_post = create_response.json()
post_id = created_post["id"]
# 2. 获取创建的资源
get_response = api_context.get(f"/posts/{post_id}")
assert get_response.status == 200, "Failed to get post"
retrieved_post = get_response.json()
assert retrieved_post["title"] == new_post["title"], "Title mismatch"
# 3. 更新资源
update_data = {"title": "Updated Title"}
update_response = api_context.patch(f"/posts/{post_id}", json=update_data)
assert update_response.status == 200, "Failed to update post"
updated_post = update_response.json()
assert updated_post["title"] == update_data["title"], "Update failed"
# 4. 删除资源
delete_response = api_context.delete(f"/posts/{post_id}")
assert delete_response.status == 200, "Failed to delete post"
# 5. 验证资源已删除
get_after_delete = api_context.get(f"/posts/{post_id}")
assert get_after_delete.status == 404, "Post should be deleted"
print("CRUD operations test passed!")
这个案例展示了如何使用Playwright Python进行完整的API测试，包括创建、读取、更新和删除操作。在实际项目中，你可以根据需要扩展这个基础框架，添加更复杂的验证逻辑和错误处理。
总结与进阶学习
通过本文的介绍，你已经掌握了Playwright Python API测试的基本用法和最佳实践。Playwright提供的API测试功能不仅功能强大，而且与浏览器自动化无缝集成，为端到端测试提供了统一的解决方案。
要深入学习Playwright API测试，可以参考以下资源：
- 官方文档：虽然本文不提供外部链接，但你可以在Playwright的官方文档中找到更详细的API参考
- 源代码：通过阅读playwright/_impl/_fetch.py了解API实现细节
- 测试案例：tests/async/test_fetch_global.py包含了大量API测试的示例
随着你的API测试需求不断增长，你可以探索Playwright的更多高级功能，如请求录制与重放、性能测试、安全测试等。Playwright的灵活性和强大功能将帮助你构建更可靠、更全面的API测试解决方案。
最后，记住API测试不仅仅是验证状态码和响应内容，更重要的是确保API的行为符合预期，能够处理各种边界情况和错误条件。通过Playwright Python，你可以构建出既强大又灵活的API测试框架，为你的应用程序质量保驾护航。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
