如何限制仅允许传递Pydantic模型指定字段至FastAPI端点

你可以通过以下几种优雅的方式实现需求，同时保留Pydantic的自动验证和错误处理能力：

方案一：创建专用输入模型（推荐） #

通过拆分模型，将输入验证和完整数据模型分离，既保证验证逻辑复用，又严格控制请求字段：

from pydantic import BaseModel, AfterValidator, Field
from uuid import UUID, uuid4
from fastapi import FastAPI

def validate_name(v: str) -> str:
    # 自定义验证逻辑示例
    if len(v) < 3:
        raise ValueError("名称长度不能少于3个字符")
    return v

Name = Annotated[str, AfterValidator(validate_name)]

# 输入模型：仅包含允许调用者传递的字段
class CreateFoo(BaseModel):
    name: Name

# 完整数据模型：包含所有字段（用于数据库存储和接口返回）
class Foo(CreateFoo):
    id: UUID = Field(default_factory=uuid4)

app = FastAPI()

def save_to_database(foo: Foo):
    # 数据库存储逻辑
    pass

@app.post('/foos')
def create_foo(foo_data: CreateFoo) -> Foo:
    foo = Foo(**foo_data.model_dump())
    save_to_database(foo)
    return foo

优点：

• 严格控制请求字段，调用者传递id会直接返回422验证错误
• 完全复用name字段的验证逻辑，无需重复编写
• 模型职责清晰，输入和输出模型分离，符合代码设计原则

方案二：使用Body参数的exclude控制字段（忽略多余字段） #

如果你不想新增模型，可以直接通过Body的exclude参数过滤掉id字段，但这种方式会忽略调用者传递的id，而不是报错：

@app.post('/foos')
def create_foo(foo: Annotated[Foo, Body(exclude=['id'])]) -> Foo:
    save_to_database(foo)
    return foo

注意：

• 调用者传递id时，该字段会被自动忽略，不会触发验证错误
• foo实例中的id仍会通过default_factory自动生成

方案三：结合extra='forbid'和Body参数（传递id时报错） #

如果想在调用者传递id时直接报错，同时复用原Foo模型，可以调整模型配置并配合Body的include参数：

class Foo(BaseModel):
    id: UUID = Field(default_factory=uuid4)
    name: Name
    
    model_config = {
        "extra": "forbid"  # 禁止传递模型中未定义的字段
    }

@app.post('/foos')
def create_foo(foo: Annotated[Foo, Body(include=['name'])]) -> Foo:
    save_to_database(foo)
    return foo

优点：

• 调用者传递id会触发422验证错误，符合“仅能传递name”的要求
• 无需新增模型，直接复用原Foo模型

缺点：

• 模型配置与接口参数绑定，灵活性不如方案一

内容的提问来源于stack exchange，提问作者deceze