FastAPI Pydantic：轻松掌握模型继承的终极指南
项目地址: https://gitcode.com/GitHub_Trending/fa/fastapi FastAPI 是一个高性能、易于学习且快速编码的现代 Python Web 框架，而 Pydantic 作为其核心数据验证库，提供了强大的模型继承功能，帮助开发者构建清晰、可维护的数据结构。本文将详细介绍如何在 FastAPI 中利用 Pydantic 实现模型继承，让你的 API 开发效率提升 10 倍！
为什么选择 Pydantic 模型继承？
在构建 API 时，我们经常遇到多个数据模型拥有相同字段的情况。例如用户注册、登录和个人信息展示都需要用户名和邮箱字段。Pydantic 的模型继承功能允许你定义一个基础模型，然后让其他模型继承它，从而避免重复代码，提高代码复用性和可维护性。
图：FastAPI 中使用 Pydantic 模型继承实现的数据结构关系示意图
基础模型继承示例
让我们从一个简单的用户模型开始。首先定义一个基础用户模型 UserBase，包含所有用户都具有的公共字段：
from pydantic import BaseModel, EmailStr
class UserBase(BaseModel):
username: str
email: EmailStr
full_name: str | None = None
然后，我们可以创建继承自 UserBase 的模型，添加特定场景所需的额外字段：
# 用户注册时需要密码
class UserIn(UserBase):
password: str
# 用户登录响应不需要密码
class UserOut(UserBase):
pass
# 数据库存储的用户包含哈希密码
class UserInDB(UserBase):
hashed_password: str
这种方式不仅减少了重复代码，还确保了各模型间的一致性。完整示例代码可查看 docs_src/extra_models/tutorial002_py310.py。
多级继承与嵌套模型
Pydantic 支持多级继承和嵌套模型，让复杂数据结构的定义变得简单。例如，我们可以定义一个 Image 模型，然后在 Item 模型中使用它，再创建一个包含多个 Item 的 Offer 模型：
from pydantic import BaseModel, HttpUrl
class Image(BaseModel):
url: HttpUrl
name: str
class Item(BaseModel):
name: str
price: float
images: list[Image] | None = None
class Offer(BaseModel):
name: str
price: float
items: list[Item]
这种嵌套结构在处理复杂 API 请求时特别有用，如电商平台的商品套餐。完整代码示例见 docs_src/body_nested_models/tutorial007_py310.py。
模型继承的高级技巧
1. 字段重写与验证
子模型可以重写父模型的字段，并添加额外的验证规则：
from pydantic import BaseModel, Field
class BaseItem(BaseModel):
name: str
price: float = Field(..., gt=0)
class DiscountItem(BaseItem):
price: float = Field(..., gt=0, lt=100) # 重写价格字段，添加上限验证
discount: float = Field(..., gt=0, lt=1)
2. 模型组合 vs 继承
当需要复用多个不相关的字段集时，可以使用模型组合而非继承：
class UserInfo(BaseModel):
name: str
email: EmailStr
class Address(BaseModel):
street: str
city: str
class UserWithAddress(UserInfo):
address: Address # 组合 Address 模型
3. 响应模型过滤
在 FastAPI 中，你可以使用继承的模型来控制 API 响应中返回的字段：
@app.post("/user/", response_model=UserOut)
async def create_user(user_in: UserIn):
# UserOut 继承自 UserBase，自动过滤掉 password 字段
return fake_save_user(user_in)
实际应用场景
模型继承在以下场景中特别有用：
- 用户管理：区分注册、登录、个人资料等不同场景的用户模型
- 电商系统：产品基础信息、库存信息、促销信息的分层定义
- 数据验证：基础验证规则的复用和特殊场景的定制
- API 版本控制：不同版本 API 之间的数据模型演进
图：使用继承模型的 FastAPI 接口在 Swagger UI 中的展示效果
总结
Pydantic 的模型继承是 FastAPI 开发中的强大工具，它能帮助你：
- 减少代码重复，提高开发效率
- 确保数据模型的一致性和可维护性
- 轻松处理复杂的嵌套数据结构
- 灵活控制 API 的输入输出格式
通过本文介绍的方法，你可以快速掌握模型继承的使用技巧，编写出更优雅、更高效的 FastAPI 应用。开始尝试在你的项目中应用这些技巧，体验数据模型设计的乐趣吧！
想要深入学习更多 FastAPI 和 Pydantic 的高级特性，可以查阅官方文档 docs/en/docs，那里有更丰富的教程和示例代码。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
