FastAPI响应模型：数据转换与校验的关键

响应模型

response_model 是 FastAPI 中的一个关键参数，用于定义 API 响应的数据结构。它通常是一个 Pydantic 模型，也可以是 Pydantic 模型组成的列表。response_model 的主要功能包括数据转换、数据校验、生成 OpenAPI 文档中的 JSON Schema，以及在自动生成的文档系统中使用。

在路径操作装饰器中，response_model 参数接收的类型与 Pydantic 模型属性声明的类型相同。路径函数可能返回一个 dict、数据库对象或其他模型，response_model 会对其进行字段约束和序列化。

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()

class UserIn(BaseModel):
    username: str
    password: str
    email: EmailStr
    full_name: str | None = None

class UserOut(BaseModel):
    username: str
    email: EmailStr
    full_name: str | None = None

@app.post("/user/", response_model=UserOut)
async def create_user(user: UserIn):
    return user

多个模型

在处理用户模型时，通常需要定义多个模型以适应不同的需求。例如，输入模型需要包含密码，而输出模型不应包含密码。数据库模型可能需要保存密码的哈希值。通过继承可以减少代码重复，定义一个基类模型 UserBase，然后创建继承该模型属性的子类。

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()

class UserBase(BaseModel):
    username: str
    email: EmailStr
    full_name: str | None = None

class UserIn(UserBase):
    password: str

class UserOut(UserBase):
    pass

class UserInDB(UserBase):
    hashed_password: str

def fake_password_hasher(raw_password: str):
    return "supersecret" + raw_password

def fake_save_user(user_in: UserIn):
    hashed_password = fake_password_hasher(user_in.password)
    user_in_db = UserInDB(**user_in.model_dump(), hashed_password=hashed_password)
    print("User saved! ..not really")
    return user_in_db

@app.post("/user/", response_model=UserOut)
async def create_user(user_in: UserIn):
    user_saved = fake_save_user(user_in)
    return user_saved

响应状态码

status_code 参数用于声明 API 响应的 HTTP 状态码。它是路径操作装饰器的一个参数，接收一个表示 HTTP 状态码的数字或 IntEnum 类型。HTTP 状态码分为信息响应、成功响应、重定向响应、客户端错误响应和服务器端错误响应。可以使用 fastapi.status 中的便捷变量来设置状态码。

from fastapi import FastAPI, status

app = FastAPI()

@app.post("/items/", status_code=status.HTTP_201_CREATED)
async def create_item(name: str):
    return {"name": name}

总结

response_model 用于定义 API 响应的数据结构，支持数据转换、校验和文档生成。多个模型通过继承减少代码重复，适应不同需求。status_code 用于声明 API 响应的 HTTP 状态码，提供便捷变量以方便使用。