怎么在Python中用pytest测试FastAPI接口

冬宇小哥_1525

冬宇小哥_1525

2026-10-28

626人浏览

原创

FastAPI官方推荐用TestClient模拟HTTP请求,需传入已配置的app实例,正确处理路径/查询参数、依赖覆盖及异步依赖,避免污染测试环境。

怎么在python中用pytest测试fastapi接口

用 TestClient 模拟真实 HTTP 请求最直接

FastAPI 官方推荐用 fastapi.testclient.TestClient,它底层基于 httpx,能完整走通路由、依赖注入、中间件和异常处理器,比手写 httpx.AsyncClient 或 aiohttp 更省心,也比 mock 视图函数更贴近真实行为。

关键点:必须传入 app 实例(不是模块名或字符串),且不能在测试中重复调用 app = FastAPI() —— 否则依赖、中间件、路由注册全丢失。

  • 正确写法:client = TestClient(app),其中 app 是你主模块里已配置好的 FastAPI 实例
  • 常见错误:在测试文件里重新 app = FastAPI(),再挂路由,导致测试的不是生产代码
  • 如果 app 依赖环境变量或数据库连接,需在测试前用 monkeypatch.setenv() 或临时替换 Depends() 的返回值

测试带路径参数、查询参数和请求体的接口要对齐 Pydantic 验证

FastAPI 的参数解析和校验发生在 TestClient 的 .get()/.post() 调用过程中,所以传参方式必须匹配声明方式 —— 否则会触发 422 错误,而不是你预期的业务逻辑分支。

示例:假设接口是 @app.post("/items/{item_id}"),接收 item_id: int 和 JSON body Item:

def test_create_item():
    response = client.post(
        "/items/123",  # ✅ 路径参数必须拼进 URL 字符串
        json={"name": "foo", "price": 9.99}  # ✅ body 用 json=,自动序列化 + 设 Content-Type
    )
    assert response.status_code == 200
  • 路径参数不能塞进 params=,否则 404;查询参数才用 params=
  • 表单数据用 data=,上传文件用 files=,别混用 json=
  • 如果接口用了 Body(..., embed=True),JSON body 必须是嵌套对象,比如 {"item": {...}}

测试依赖覆盖要用 app.dependency_overrides,别改源码或全局 patch

真实接口常依赖数据库、缓存、认证等外部服务。测试时必须切断这些依赖,但又不能破坏 FastAPI 的依赖解析链 —— 直接修改模块级变量或 monkeypatch 函数容易漏掉异步依赖或被中间件绕过。

标准做法是在每个测试前后用 app.dependency_overrides 注入可控的替代实现:

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
def test_read_user_with_mock_db():
    async def override_get_db():
        return MockDBSession()  # 返回假 session,不连真实 DB
<pre class="brush:php;toolbar:false;">app.dependency_overrides[get_db] = override_get_db
try:
    response = client.get("/users/1")
    assert response.json()["id"] == 1
finally:
    app.dependency_overrides.clear()  # ⚠️ 必须清理,否则污染其他测试

  • 务必在 try/finally 或 pytest fixture 的 yield 后清理 dependency_overrides
  • 不要用 unittest.mock.patch 去 patch get_db,FastAPI 不会识别被 patch 的函数对象
  • 如果依赖是类实例(如 CacheService),可直接 app.dependency_overrides[CacheService] = lambda: MockCache()

异步依赖或 BackgroundTasks 需手动 await 或 patch

FastAPI 允许路由函数返回 coroutine,或接收 BackgroundTasks。但 TestClient 是同步的,它会自动 await 路由返回的协程 —— 所以你写的测试函数本身可以是普通函数,不用 async def。

但有两点必须注意:

  • 如果依赖里有 await(比如 async def get_current_user()),确保你覆盖的 mock 也返回 awaitable,或直接返回结果(TestClient 会兼容)
  • BackgroundTasks.add_task() 在测试中默认不会执行,需用 monkeypatch.setattr 拦截并验证是否被调用,或改用同步模拟版本
  • 若真要测任务执行逻辑,得换 httpx.AsyncClient + pytest-asyncio,但代价高,通常 mock 更合理

复杂点往往不在怎么发请求,而在怎么让依赖“停住”又不漏掉异步环节 —— 尤其当多个依赖嵌套 await、中间件也参与生命周期时,dependency_overrides 的清理时机和类型匹配稍有偏差,测试就会通过但线上出错。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python fastapi

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1811

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4844

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1769

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

28937

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3467

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3467

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1223

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2683

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习