【后端】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 📦

相关推荐
Decay__2 小时前
PostgreSQL 数据库全栈运维实战系列 — 合集索引(24 篇)
运维·数据库·sql·mysql·架构
wuyk5553 小时前
Python办公自动化-第01讲-环境搭建与自动化认知
python·自动化·pyqt
学长毕设4 小时前
基于SpringBoot的儿童慈善捐赠管理系统-附源码
java·spring boot·后端
高洁014 小时前
数字孪生与计算机视觉:让机器看懂现场
人工智能·python·机器学习·transformer·迁移学习
ComPDFKit4 小时前
RAG 回答只显示 PDF 文件名?用 Python 保留引用页码
开发语言·python·pdf·rag
皮皮林5514 小时前
GitHub Copilot:你可以暂时不用,但别不知道它有多强
后端
学长毕设5 小时前
基于SpringBoot非遗文化展示与传播平台设计与实现-附源码
java·spring boot·后端
yz_aiks5 小时前
Termux 使用教程:把安卓手机变成随身 Linux(装 Python、SSH 远程、跑自动化脚本)
android·linux·python·智能手机·ssh·termux
杨凯凡5 小时前
Spring Boot SSE 上线后不实时、频繁断线?Nginx 缓冲、心跳与连接回收实战
spring boot·后端·nginx
锋行天下6 小时前
langgraph 全栈项目(三)
前端·人工智能·后端