FastAPI 学习之路(九)请求体有多个参数如何处理?
系列文章:
FastAPI 学习之路(一)fastapi--高性能web开发框架
请求体有多个参数如何处理?
别的不多说,我们先写一个需求,然后演示下如何展示。
需求:写一个接口,传递以下参数,书本的名称,描述,价格,打折。
接口返回返回最后的价格
我们去看下代码如何实现
from typing import Optional from fastapi import FastAPI from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: str description: Optional[str] = None price: float tax: Optional[float] = None @app.put("/items") def update_item(item: Optional[Item]): result={} if item.tax is not None: total=item.price*item.tax result['price'] = total result['name']=item.name return result result['price'] = item.price result['name'] = item.name return result
那么我们测试下,最后是否实现了这个功能,当我们输入所有的参数的时候。
最后是在我们实际的打折上返回的。
那么我们看下,我们不增加打折如何返回
没有打折就原价返回了名称和价格。
如果默认给了None或者其他内容,这个参数就是可以选择增加或者不增加。但是没有给默认值的时候,就是必须传递的,否则会返回对应的错误,我们可以看下。假如我们不传递价格。
我们可以看到没有默认值的参数就是一个必须的。不然接口会返回对应的错误。
除了声明以上单个的,我们还可以声明多个请求体参数,比如我们可以在之前的需求,增加一个返回,要求返回作者,和作者的朝代。如何实现呢。
from typing import Optional from fastapi import FastAPI from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: str description: Optional[str] = None price: float tax: Optional[float] = None class User(BaseModel): username: str year: str @app.put("/items") async def update_item(item: Optional[Item],user:User): result={} if item.tax is not None: total=item.price*item.tax result['price'] = total result['name']=item.name result['user']=user return result result['price'] = item.price result['name'] = item.name result['user']=user return result
那么我们看下接口的请求
当我们增加打折。看下返回结果
我们可以看下接口的返回。
FastAPI 将自动对请求中的数据进行转换,因此 item 参数将接收指定的内容,user 参数也是如此。
我们要想在增加一个键,在哪里出售,但是要作为请求体的另一个键进行处理,如何 实现呢
from typing import Optional from fastapi import FastAPI,Body from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: str description: Optional[str] = None price: float tax: Optional[float] = None class User(BaseModel): username: str year: str @app.put("/items") async def update_item(item: Optional[Item],user:User,sell:str=Body(...)): result={} if item.tax is not None: total=item.price*item.tax result['price'] = total result['name']=item.name result['user']=user result['sell']=sell return result result['price'] = item.price result['name'] = item.name result['user']=user result['sell'] = sell return result
我们可以看到如下
假如我们把参数放在查询内,返回错误
参数必须放在body内请求。
文章首发在公众号,欢迎关注。