FastAPI学习笔记(一)-11.响应模型基本使用

'''
@author:invoker
@project:fastapi202108
@file: chapter041.py
@contact:invoker2021@126.com
@descript:
@Date:2021/8/5 21:22
@version: Python 3.7.8
'''

from fastapi import APIRouter
from pydantic import BaseModel, EmailStr,Field
from typing import Optional

# 路由对象app04
app041 = APIRouter()

"""
响应模型
"""


# 用户基本信息-基本模型体
class UserInfo(BaseModel):
    username: str
    email: EmailStr
    mobile: str = "15900000003"
    address: str = None
    full_name: Optional[str] = None


# 输入用户信息-请求模型体
class inputUserModel(UserInfo):
    password: str


# 返回用户信息,响应模型体
class returnUserModel(UserInfo):
    # userId: int=Field(default=1)
    pass


users = {
    "user01": {"username": "invoker", "email": "invoker2021@126.com"},
    "user02": {"username": "pudge", "email": "pudge@126.com", "mobile": "15900000002", "address": "夜宴",
               "full_name": "futu pudge"}
}


# response_model叫做路径操作(path operation)
# response_model_exclude_unset = False 表示返回值设置为空时，返回值会将默认值填充到返回值内。
@app041.post('/response_model_1', response_model=returnUserModel, response_model_exclude_unset=False)
async def response_model(user: inputUserModel):
    print(user.password)
    return users["user01"]

1.以上代码定义了请求模型 inputUserModel 和 响应模型 returnUserModel 2个类。

请求模型：

# 用户基本信息-基本模型体
class UserInfo(BaseModel):
    username: str
    email: EmailStr
    mobile: str = "15900000003"
    address: str = None
    full_name: Optional[str] = None


# 输入用户信息-请求模型体
class inputUserModel(UserInfo):
    password: str


响应模型：

# 用户基本信息-基本模型体
class UserInfo(BaseModel):
    username: str
    email: EmailStr
    mobile: str = "15900000003"
    address: str = None
    full_name: Optional[str] = None


# 返回用户信息,响应模型体
class returnUserModel(UserInfo):
    # userId: int=Field(default=1)
    pass

2.定义了返回值 users

 

3.设置response_model_exclude_unset = False 表示返回值设置为空时，返回值会将默认值填充到返回值内

接口1：/chapter041/response_model_1

返回值：

{ "username": "invoker", "email": "invoker2021@126.com", "mobile": "15900000003", "address": null, "full_name": null }

 

4.response_model_exclude_unset = True 表示返回值如果为空，则返回空，不会将默认值填写返回

接口2：/chapter041/response_model_2

返回值：

{ "username": "invoker", "email": "invoker2021@126.com" }

 

5.合并模型Union

接口3：/chapter041/response_model_3/attributes

'''
@author:invoker
@project:fastapi202108
@file: chapter041.py
@contact:invoker2021@126.com
@descript:
@Date:2021/8/5 21:22
@version: Python 3.7.8
'''

from fastapi import APIRouter
from pydantic import BaseModel, EmailStr, Field
from typing import Optional, Union

# 路由对象app04
app041 = APIRouter()

"""
响应模型
"""


# 用户基本信息-基本模型体
class UserInfo(BaseModel):
    username: str
    email: EmailStr
    mobile: str = "15900000003"
    address: str = None
    full_name: Optional[str] = None


# 输入用户信息-请求模型体
class inputUserModel(UserInfo):
    password: str


# 返回用户信息,响应模型体
class returnUserModel(UserInfo):
    # userId: int=Field(default=1)
    pass


users = {
    "user01": {"username": "invoker", "email": "invoker2021@126.com"},
    "user02": {"username": "pudge", "email": "pudge@126.com", "mobile": "15900000002", "address": "夜宴",
               "full_name": "futu pudge"}
}


# response_model叫做路径操作(path operation)
# response_model_exclude_unset = False 表示返回值设置为空时，返回值会将默认值填充到返回值内。
@app041.post('/response_model_1', response_model=returnUserModel, response_model_exclude_unset=False)
async def response_model(user: inputUserModel):
    print(user.password)
    return users["user01"]


# response_model_exclude_unset = True 表示返回值如果为空，则返回空，不会将默认值填写返回。
@app041.post('/response_model_2', response_model=returnUserModel, response_model_exclude_unset=True)
async def response_model(user: inputUserModel):
    print(user.password)
    return users["user01"]


@app041.post(
    '/response_model_3/attributes',
    # 将请求模型和返回模型合并
    response_model=Union[inputUserModel, returnUserModel],
    response_model_exclude_unset=True
)
async def reponse_model_attributes(user: inputUserModel):
    # 小技巧，删除掉password
    del user.password
    return user

from typing import Union

小技巧，去掉密码，使用del user.password

 

返回值：

{ "username": "invoker", "email": "user@example.com", "mobile": "15900000003", "address": "填在" }

 

6.模型技巧2 List+response_model_exclude,response_model_include

'''
@author:invoker
@project:fastapi202108
@file: chapter041.py
@contact:invoker2021@126.com
@descript:
@Date:2021/8/5 21:22
@version: Python 3.7.8
'''

from fastapi import APIRouter
from pydantic import BaseModel, EmailStr, Field
from typing import Optional, Union, List

# 路由对象app04
app041 = APIRouter()

"""
响应模型
"""


# 用户基本信息-基本模型体
class UserInfo(BaseModel):
    username: str
    email: EmailStr
    mobile: str = "15900000003"
    address: str = None
    full_name: Optional[str] = None


# 输入用户信息-请求模型体
class inputUserModel(UserInfo):
    password: str


# 返回用户信息,响应模型体
class returnUserModel(UserInfo):
    # userId: int=Field(default=1)
    pass


users = {
    "user01": {"username": "invoker", "email": "invoker2021@126.com"},
    "user02": {"username": "pudge", "email": "pudge@126.com", "mobile": "15900000002", "address": "夜宴",
               "full_name": "futu pudge"}
}


# response_model叫做路径操作(path operation)
# response_model_exclude_unset = False 表示返回值设置为空时，返回值会将默认值填充到返回值内。
@app041.post('/response_model_1', response_model=returnUserModel, response_model_exclude_unset=False)
async def response_model(user: inputUserModel):
    print(user.password)
    return users["user01"]


# response_model_exclude_unset = True 表示返回值如果为空，则返回空，不会将默认值填写返回。
@app041.post('/response_model_2', response_model=returnUserModel, response_model_exclude_unset=True)
async def response_model(user: inputUserModel):
    print(user.password)
    return users["user01"]


@app041.post(
    '/response_model_3/attributes',
    # 将请求模型和返回模型合并
    response_model=Union[inputUserModel, returnUserModel],
    response_model_exclude_unset=True
)
async def reponse_model_attributes(user: inputUserModel):
    # 小技巧，删除掉password
    del user.password
    return user


@app041.post(
    '/response_model_4/List',
    response_model=List[returnUserModel],
    response_model_exclude_unset=True,
    response_model_include=['username', 'email','password'],
    response_model_exclude=['mobile', 'address']

)
async def reponse_model_list(user: inputUserModel):
    # 小技巧，删除掉password
    del user.password
    return [user, user]

 

接口4：/chapter041/response_model_4/List

6.1使用response_model=List[returnUserModel]，定义返回的是以returnUserModel为模型的列表格式。

return [user,user]

6.2 使用response_model_include=['username','email','password'] 表示返回值必须要显示的字段。

      使用response_model_exclude=['mobile','address']标志返回值一定不显示的字段

6.3 del user.password的小技巧导致返回值不会显示password

综上所述，

请求报文：

{
"username": "invoker",
"email": "invoker2021@126.com",
"mobile": "15900000003",
"address": "天辉中路",
"full_name": "卡尔invoker",
"password": "123321"
}

返回报文：

[ { "username": "invoker", "email": "invoker2021@126.com" }, { "username": "invoker", "email": "invoker2021@126.com" } ]