全面拥抱 FastApi — 响应模型

本文介绍FastAPI如何利用response_model进行数据转换和验证,包括自定义输出模型、省略默认值、灵活控制返回内容,以及响应模型在API文档生成中的作用。通过实例演示了如何在实际场景中优化响应结构。

大家好,我是村长~~ 今日 fastApi 干货来了,文末还有书籍赠送噢~~

fastApi 中可以定义请求体body模型,关于这部分内容可以查看之前的文章 地址:同样的,fastApi 支持在定义路径操作的时候,使用response_model 参数指明该路径的响应模型

其具有以下特点:

  • 转换为类型声明的输出数据

  • 响应数据的校验

  • 在 OpenAPI 路径操作中,为响应添加 JSON Schema

  • 生成 API 文档

其中,个人觉得最重要的一点是:把输出的数据字段限制在该模型以内!

而且,response_model 接收的类型与声明 Pydantic 模型属性的类型,语法完全相同

使用响应模型

先来看下简单的用法,定义一个响应模型 User

from pydantic import BaseModel, EmailStr

class User(BaseModel):
    name: str
    sex: str = "male"
    age: int
    email: EmailStr
    phone: str

定义完模型之后,在路径操作装饰器函数中设置

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

全村之希望

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值