【后端】FastAPI的Pydantic 模型

Pydantic是 FastAPI 用来"收"和"回"数据的格式说明书。

我们在写接口时,客户端会:

  • "传数据"给你(输入),比如注册/登录时提交用户名和密码。

  • "拿数据"回去(输出),比如你登录成功后返回 JWT 令牌。

👉 那这些数据怎么写?要哪些字段?什么类型?有没有格式限制?

Pydantic 模型就是用来定义这些数据格式的。


📥 举个例子:用户注册

你写了一个注册接口 /register,用户传来这个 JSON:

复制代码
{
  "username": "alice",
  "password": "123456"
}

你需要验证:

  • 有没有 username 字段?它是不是字符串?

  • password 有没有?是不是字符串?

👉 Pydantic 就是干这个活的

我们用 UserCreate 模型定义这个请求体结构:

复制代码
class UserCreate(BaseModel):
    username: str
    password: str

FastAPI 自动把用户提交的数据拿去套这个模型检查 。如果不符合(比如 password 是数字、username 没填),会直接返回错误,不会走到数据库或后续逻辑,保证你收到的就是干净合法的数据


📤 举个例子:登录响应

你登录成功了,要给客户端返回 JWT 令牌。你希望格式是这样的:

复制代码
{
  "access_token": "xxxxx",
  "token_type": "bearer"
}

我们用这个模型描述这个结构:

复制代码
class Token(BaseModel):
    access_token: str
    token_type: str

FastAPI 自动会把你写在返回值里的字典转成这个格式,客户端拿回的 JSON 就规范了。


🧩 Pydantic 模型 = 两件事:

模型名 干的事(请求) 干的事(响应)
UserCreate 验证用户提交的数据是否合法 不用于响应
Token 不用于请求 定义你返回给用户的令牌格式

🔄 总结一句话

你可以把 Pydantic 理解成"接口数据说明书"。

  • 当别人调用你的接口时,FastAPI 用它来帮你检查数据合法性 ✅

  • 当你返回数据给别人时,FastAPI 用它来帮你自动生成标准 JSON 📦

相关推荐
Source.Liu5 分钟前
【Python自动化】 21.1 Pandas 读取 Excel 文件的完整指南
python·自动化·pandas
张人玉6 分钟前
SQLSERVER数据备份
数据库·oracle·sqlserver
Ka1Yan12 分钟前
MySQL索引优化
开发语言·数据结构·数据库·mysql·算法
TDengine (老段)18 分钟前
TDengine 时间函数 TIMETRUNCATE 用户手册
java·大数据·数据库·物联网·时序数据库·tdengine·涛思数据
堕落年代18 分钟前
Spring Boot HTTP状态码详解
spring boot·后端·http
Hello Mr.Z20 分钟前
使用pytorch创建/训练/推理OCR模型
人工智能·pytorch·python
Victor35623 分钟前
Redis(49)Redis哨兵如何实现故障检测和转移?
后端
Victor35626 分钟前
Redis(48)Redis哨兵的优点和缺点是什么?
后端
MediaTea27 分钟前
Python 内置函数:pow()
开发语言·python
AndrewHZ32 分钟前
【图像处理基石】图像预处理方面有哪些经典的算法?
图像处理·python·opencv·算法·计算机视觉·cv·图像预处理