如何在Python中编写单元测试以确保Web API的稳定性？-Python教程-PHP中文网

testclient可直接调用路由函数，避免启动真实服务；需覆盖路径、查询、json参数组合；用mock隔离db和外部依赖；断言应检查状态码、关键字段及类型；异步端点测试须用async/await。

如何在python中编写单元测试以确保web api的稳定性？

FastAPI 和 Flask 都自带 TestClient，它不依赖真实 HTTP 服务器，直接调用路由函数，速度快、隔离性好。别用 requests 去连本地 http://localhost:8000——那会启动真实服务、端口冲突、状态残留，还慢。

实操建议：

Web API 的输入往往混合了多种参数类型，单测必须覆盖典型组合，否则上线后容易 422 或空指针。

常见错误现象：ValidationError 报错但没定位到是哪个字段缺失，或 None 被传进数据库导致 IntegrityError。

实操建议：

路径参数：用 client.get("/items/123")，确保路径模板（如 /items/{item_id}）能正确解析字符串转 int
查询参数：显式构造字典传给 params=，如 client.get("/search", params={"q": "test", "limit": 5})
JSON body：用 json= 参数（TestClient 自动序列化+设 Content-Type: application/json），别手动 json.dumps() + headers
故意传非法值（如空字符串、负数 ID、超长字段）验证 Pydantic 模型的 validation_error 是否返回 422

真实调用数据库或第三方 API 会让单元测试变慢、失败率升高、难以复现问题。必须隔离。

python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构，支持CLI、API、爬虫、Bot、Django等多种项目类型，包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载

使用场景：比如一个 /orders 接口内部调用了 payment_service.charge() 和 db.insert_order()。

实操建议：

用 unittest.mock.patch 装饰器或上下文管理器打桩，如 @patch("app.services.payment_service.charge")
对数据库操作，mock session.execute() 或直接替换 db_session fixture 返回 Mock 对象
避免 patch 太宽泛（如 @patch("requests.post")），应精确到模块内具体函数，否则可能漏掉未 mock 的调用
为 mock 设置 return_value 或 side_effect，例如让某次调用抛出 ConnectionError 测试异常分支

只断言 response.status_code == 200 不够。API 返回结构变化（比如字段改名、嵌套层级调整）不会影响状态码，但前端会崩。

性能影响：深比较整个 JSON 响应体效率低，且易因无关字段（如时间戳、UUID）导致误报。

实操建议：

优先 assert 状态码 + 必要字段存在性 + 类型，例如：assert response.json()["id"] == 123、assert isinstance(response.json()["created_at"], str)
用 pydantic.BaseModel.parse_obj() 验证响应结构是否符合预期模型，比手写 key 检查更可靠
对列表接口，检查 len(response.json()) > 0 即可，除非业务明确要求条数
不要在测试里写 print(response.json())，用 pytest 的 -s 或日志配置调试输出

最常被忽略的是异步端点的测试方式——如果路由是 async def，测试函数也得加 async 并用 await client.get(...)，否则会报 RuntimeWarning: coroutine '...' was never awaited。