FastAPI中实现动态条件必填字段的实践
title: FastAPI中实现动态条件必填字段的实践
from pydantic import BaseModel, Field, model_validator
from typing import Optional, Literal
class UserRegistration(BaseModel):
register_type: Literal["email", "mobile"] # 限定注册类型枚举值
email: Optional[str] = Field(None, pattern=r"^[\w\.-]+@[\w\.-]+\.\w+$")
mobile: Optional[str] = Field(None, pattern=r"^1[3-9]\d{9}$")
accept_promotion: bool = False
@model_validator(mode='before')
def validate_required_fields(cls, values):
reg_type = values.get('register_type')
errors = []
# 根据注册类型检查对应字段
if reg_type == "email" and not values.get("email"):
errors.append("email is required for email registration")
elif reg_type == "mobile" and not values.get("mobile"):
errors.append("mobile is required for mobile registration")
# 检查促销订阅条件
if values.get("accept_promotion"):
if not values.get("email") and not values.get("mobile"):
errors.append("email or mobile required for promotion subscription")
if errors:
raise ValueError("; ".join(errors))
return values
# 字段定义部分
register_type: Literal["email", "mobile"] → 限制输入值只能是枚举值
Field(None, pattern=r"正则表达式") → 设置默认值并添加格式验证
# 验证器核心逻辑
@model_validator(mode='before')
→ 在类型转换前执行验证
values.get('register_type') → 获取字段原始值（未经过类型转换）
values.get("email") → 获取字段原始输入值
raise ValueError → 触发验证错误（FastAPI会自动转换为422响应）
from fastapi import FastAPI
app = FastAPI()
@app.post("/register")
async def user_registration(data: UserRegistration):
# 成功通过验证后才会执行到这里
return {
"message": "Registration successful",
"data": data.model_dump()
}
# 有效请求1（邮箱注册）
{
"register_type": "email",
"email": "user@example.com"
}
# 有效请求2（手机注册+促销订阅）
{
"register_type": "mobile",
"mobile": "13800138000",
"accept_promotion": true
}
# 无效请求1（缺少邮箱）
{
"register_type": "email"
} → 返回422错误："email is required for email registration"
# 无效请求2（促销订阅但无联系方式）
{
"register_type": "email",
"accept_promotion": true
} → 返回422错误："email or mobile required for promotion subscription"
{
"detail": [
{
"type": "value_error",
"msg": "Value error, email is required for email registration",
"loc": [
"body"
]
}
]
}
Field(..., description="用户邮箱地址", examples=["user@example.com"])
答案解析 正确答案：B @model_validator(mode='before') 可以访问所有原始输入值，适合处理跨字段的联合验证逻辑。当需要基于多个字段的原始值（尚未经过类型转换）进行判断时，必须使用before模式的模型验证器。
答案解析 正确答案：D Pydantic的验证机制是叠加式的： 1. 通过Field的pattern参数进行正则验证 2. 通过@field_validator进行格式补充验证 3. 在模型验证器中处理必填逻辑 这些验证器会按声明顺序依次执行，共同确保数据有效性。
答案解析 正确答案：D 组合调试方案： 1. 查阅Swagger文档中的请求示例格式 2. 在验证器中打印values值观察处理过程 3. 通过如下代码捕获详细错误信息：
from pydantic import ValidationError
try:
UserRegistration(**data)
except ValidationError as e:
print(e.errors())
评论
发表评论