FastAPI 学习之路(四)使用pydantic模型做请求体
FastAPI 学习之路(十三)Cookie 参数,Header参数
前言
我们之前分享的是Cookie,Header参数相关的。这次我们来看下响应模型。我们之前看的都是请求模型,请求参数,这次呢,我们看下响应相关的。
正文
我们可以在我们不同的请求路径的返回参数使用响应模型。我们看一个简单的demo。
from typing import List, Optional
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class One(BaseModel):
name: str
description: Optional[str] = None
price: float
tax: Optional[float] = None
@app.post("/items/", response_model=One)
def create_item(item: One):
return item
我们可以看下,接口的正常返回
response_model是「装饰器」方法(get,post 等)的一个参数。不像之前的所有参数和请求体,它不属于路径操作函数。
它接收的类型与你将为 Pydantic 模型属性所声明的类型相同,因此它可以是一个 Pydantic 模型,但也可以是一个由 Pydantic 模型组成的 list
,例如 List[Item]
。
FastAPI 将使用此 response_model
来:
但最重要的是:
我们下面做一个演示,我们正常的都应该知道,我们去创建用户的时候呢,我们的密码是明文的,我们要返回的用户信息中,不能携带我们的密码,我们应该如何处理呢,其实很简单
from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class UserIn(BaseModel):
username: str
password: str
email: str
full_name: Optional[str] = None
class Userout(BaseModel):
username: str
email: str
full_name: Optional[str] = None
@app.post("/user/", response_model=Userout)
def create_user(user: UserIn):
return user
我们看下接口的实际返回
我们看下接口的文档的展示
我们在接口的请求中,如果不传递,我不想要返回带默认值的,
我们看下代码如何实现的
from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class UserIn(BaseModel):
username: str
password: str
email: str
full_name: Optional[str] = None
class Userout(BaseModel):
username: str
email: str
full_name: Optional[str] = None
@app.post("/user/", response_model=Userout,response_model_exclude_unset=True)
def create_user(user: UserIn):
return user
其实就是response_model_exclude_unset来处理,我们看下实际的效果
那么这个时候,我们传递了呢。
可以看到,我们传递了参数就可以正常的展示,不传递参数的,我们不返回默认的值。
后记
发现问题,解决问题。遇到问题,慢慢解决问题即可。
欢迎关注雷子说测试开发,后续将会持续为大家分享更多的技术知识
如果你有问题可以留言或者加我微信:952943386。2021,一起牛转钱坤,一起牛逼。
如果觉得这篇文章还不错,来个【分享、点赞、在看】三连吧,让更多的人也看到~