怎样在Python中利用FastAPI的Pydantic进行参数校验

风婷姑娘_3932

风婷姑娘_3932

2026-10-29

683人浏览

原创

FastAPI通过类型提示+Pydantic模型自动校验请求参数:需将BaseModel子类作为路径操作函数参数(非返回值或dict/Any),支持Body(JSON)、Query(查询参数)、Path(路径参数)三种位置;校验失败返回422及OpenAPI标准错误格式;自定义校验用@field_validator(单字段)和@model_validator(mode="after")(跨字段),注意默认值叠加逻辑。

怎样在python中利用fastapi的pydantic进行参数校验

Pydantic模型定义后,FastAPI如何自动校验请求参数

FastAPI不是靠装饰器或手动调用校验函数来验证参数的——它靠的是类型提示 + Pydantic模型声明。只要你把函数参数标注为一个继承自 BaseModel 的类,FastAPI 就会在收到请求时自动解析 JSON、校验字段类型和约束,并在失败时返回 422 错误。

常见错误现象:定义了 BaseModel,但没在路由函数里作为参数使用(比如只当返回值),结果完全没触发校验;或者用了 dict 或 Any 类型注解,绕过了 Pydantic 校验流程。

  • 必须把模型作为路径操作函数的参数,且不加 * 或 ** 解包
  • 支持三种位置:查询参数(Query)、请求体(默认,即 Body)、路径参数(需用 Path 显式声明)
  • 如果想让多个字段都从 body 解析但又不想包一层外层键,用 Body(..., embed=True)

如何区分 Query、Path、Body 三种参数校验方式

FastAPI 会根据参数类型注解和默认值自动判断参数来源,但容易混淆的是:同个 Pydantic 模型既可能被当查询参数拆开传,也可能被当 JSON 整体传——关键看你怎么声明。

典型误用:把本该是 JSON body 的模型,写成 def endpoint(item: Item = None),导致 FastAPI 认为它是可选查询参数,字段全变成 query string,丢失嵌套结构和类型语义。

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

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

下载
  • 请求体(JSON):直接写 item: Item(无默认值)或 item: Item = Body(...)
  • 查询参数(query string):每个字段单独写,或用 item: Item = Query(...)(不推荐,仅限简单扁平模型)
  • 路径参数:必须显式用 id: int = Path(..., gt=0),Pydantic 模型不能直接用于路径参数
  • 混合场景:比如路径 ID + body 数据,就写成 def endpoint(id: int = Path(...), item: Item = Body(...))

校验失败时的错误响应格式与调试技巧

FastAPI 默认返回的 422 响应体是标准 OpenAPI 兼容格式,包含 detail 数组,每项有 loc(出错位置)、msg(提示)、type(错误类型)。但开发时容易忽略 loc 的嵌套逻辑,比如 ["body", "price"] 表示 price 字段在请求体中,而 ["query", "limit"] 表示 limit 是查询参数。

  • 字段缺失时,loc 是 ["body", "field_name"];类型错误时同理
  • 嵌套模型出错,loc 会体现层级,如 ["body", "user", "email"]
  • 想快速定位问题,用 curl -v 看响应头和 body,别只依赖前端控制台
  • 本地调试可临时加 @app.exception_handler(RequestValidationError) 捕获并打印完整 exc.errors()

自定义校验逻辑(如字段间依赖、条件必填)怎么写

Pydantic v2(FastAPI 0.100+ 默认)用 @model_validator(mode="after") 和 @field_validator,而不是旧版的 @validator。很多人还在抄 v1 写法,导致校验器根本不执行。

典型陷阱:在 @field_validator 里访问其他字段值——不行,它只接收当前字段值;跨字段逻辑必须用 @model_validator(mode="after"),此时 self 是已部分构建的模型实例。

  • 单字段清洗:用 @field_validator("price"),接收 v: Any,返回处理后值
  • 字段依赖校验:比如 “status=active 时 email 必填”,写 @model_validator(mode="after"),然后 if self.status == "active" and not self.email: 抛 ValueError
  • 注意:自定义 validator 中抛异常要用 ValueError 或 AssertionError,FastAPI 会转成标准错误格式

实际项目里最常被忽略的,是 Pydantic 模型字段默认值和 FastAPI 参数默认值的叠加行为——比如模型里 price: float = 0.0,接口又写 item: Item = Body(...),那 price 就真成了必填;但如果写成 item: Item = Body(Item()),才表示允许缺省并用模型默认值填充。这个细节不厘清,测试用例很容易漏掉边界情况。

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

1831

4

python能做什么
python能做什么

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

2023.07.25

4864

7

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

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

2023.07.31

1769

3

python教程
python教程

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

2023.08.03

29077

23

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

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

2023.08.04

3487

5

python eval
python eval

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

2023.08.04

3487

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

2703

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习