如何在Python中用pytest测试FastAPI接口

雨静君_5346

雨静君_5346

2026-10-06

137人浏览

原创

fastapi官方推荐用testclient模拟http请求,需传入app实例、手动填充路径参数、用params传查询参数、response.json()解析响应、依赖覆盖用app.dependency_overrides。

如何在python中用pytest测试fastapi接口

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

FastAPI 官方推荐用 fastapi.testclient.TestClient 包裹应用实例,它底层复用 Starlette 的测试客户端,能走通完整路由、依赖注入、中间件和异常处理器,比手写 httpx.AsyncClient 或 mock 路由函数更可靠。

关键点:必须传入 app 实例(不是模块名或字符串),且不能在 TestClient 初始化时加 base_url —— 它不支持异步上下文,所有请求都走同步阻塞调用,但对测试足够快。

  • TestClient 不会启动服务器,不占端口,也不需要 uvicorn.run()
  • 若接口依赖 Depends 中的异步函数(比如数据库连接),需提前 patch 或改用同步替代实现,否则会报 RuntimeError: async generator ... not awaited
  • 上传文件要用 files={"file": ("name.txt", b"content", "text/plain")} 格式,不能直接传 bytes

测试带路径参数和查询参数的接口要写全 URL

TestClient.get() 不自动拼接路径参数(如 /items/{item_id} 中的 {item_id}),必须手动填进 URL 字符串里;查询参数则通过 params 字典传,和 requests 一致。

容易错的地方是混淆 FastAPI 路径模板和实际请求路径 —— 比如定义了 @app.get("/users/{uid}"),测试时得写 client.get("/users/123"),而不是 client.get("/users", params={"uid": "123"}),后者会 404。

python-script-generator
python-script-generator

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

下载
  • 路径参数必须是字符串类型(client.get("/users/123")),即使路由声明为 int,TestClient 也会触发类型转换
  • 查询参数值如果是 None,会被忽略;空字符串 "" 会作为有效值发送
  • 如果接口用了 Body(embed=True),请求体必须套一层 key,比如 {"item": {"name": "foo"}}

验证响应状态码和 JSON 数据用 response.status_code 和 response.json()

别用 response.text 手动解析 JSON,response.json() 会自动解码并抛出清晰错误(比如 JSONDecodeError),方便定位响应格式问题。

常见误判:把 status_code == 200 当作“成功”,但 FastAPI 常用 201 Created、204 No Content 等,应严格按接口文档断言。

  • response.json() 返回的是 Python 原生对象(dict/list),可直接用 assert "key" in resp 或 assert resp["count"] == 5
  • 如果响应是空 body(如 204),调用 response.json() 会报 ValueError: No JSON object could be decoded,此时应先检查 response.status_code 再决定是否解析
  • 二进制响应(如图片)用 response.content,别用 .json()

测试依赖项(如数据库)得替换为内存实现或 Mock

真实数据库会让测试变慢、不可靠、难清理。FastAPI 的依赖覆盖机制(app.dependency_overrides)是标准解法:在测试前临时替换依赖函数,测试后清掉。

注意别漏掉 del app.dependency_overrides[xxx],否则会影响后续测试;更稳妥的做法是在 pytest fixture 里用 yield 自动清理。

  • 数据库依赖常用 sqlite:///:memory: + create_all() 搭配,避免文件 IO
  • 如果依赖里用了 async def,而你替换成同步函数,TestClient 仍能跑通,但逻辑上已偏离运行时行为 —— 这种情况建议用 httpx.AsyncClient 配合 pytest-asyncio
  • 不要在测试里直接修改全局 app.state,它不会被自动重置,可能污染其他测试
测试里最麻烦的其实是依赖链嵌套和异步边界 —— 比如一个路由依赖 A,A 又依赖 B,B 调数据库,这时候光 mock 最外层没用,得逐层控制。动手前先看清楚依赖图,比硬写断言重要得多。

大量免费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

1651

4

python能做什么
python能做什么

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

2023.07.25

4124

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

23877

23

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

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

2023.08.04

2927

5

python eval
python eval

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

2023.08.04

2947

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2283

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程