fastapi(四)请求正文

当你需要从client发送数据到你的api的时候,需要将其作为请求正文发送。
request是客户端发送数据到api,response是api发送数据到客户端。
你的api总是需要发送response body 但是客户端并不是必须发送request body

为了声明请求正文,可以使用pydantic 模块
注意:
发送请求正文,不能使用GET方法,只能使用POST、PUT、DELETE或者PATCH
eg:

from fastapi import FastAPI
from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None


app = FastAPI()


@app.post("/items/")
async def create_item(item: Item):
    return item

导入pydantic BaseModel
from pydantic import BaseModel

创建数据模型
给每个属性使用标准的python 类型

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None
    

就和声明查询参数一样,当模型的属性拥有默认值的时候,它并不是必须的,否则就是必须的,使用None值使他作为一个选项。

参数声明

async def create_item(item:Item):

结果
随着python的类型声明,python将:
1、以json格式读取request body
2、如果需要转换类型
3、验证数据(如果数据验证不通过,将返回错误)
4、将接收到数据赋值给item变量
5、然后转换为你定义的Item schema
6、这些模式将会自动用于文档ui中
使用模型
在函数内部,你可以直接去访问模型的属性。

price_with_tax=item.price+item.tax

请求正文+路径参数
fastapi将自动识别函数中来自路径中的参数,并且当参数被声明为pydantic 模型时,该参数来自请求正文。

@app.put("/items/{item_id}")
async def create_item(item_id: int, item: Item):

请求正文+路径+查询参数
fastapi将会识别每一个参数,并从正确的地方获取数据。

@app.put("/items/{item_id}")
async def create_item(item_id: int, item: Item, q: str = None):

函数的参数读取遵从一下规则:
1、如果参数在路径中被声明,它将被用于路径参数
2、如果参数是单一类型(like int,float,str,bool,etc),它将会被识别为查询参数。
3、如果参数被声明为pydantic 模型,它将会从请求正文中获取数据。

  • 3
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值