fastapi教程-进阶五（Response Model）

最新推荐文章于 2024-09-08 12:16:15 发布

一只路过的小码农cxy

最新推荐文章于 2024-09-08 12:16:15 发布

阅读量5k

点赞数 2

分类专栏： fastapi 文章标签： fastapi python

本文链接：https://blog.csdn.net/weixin_40156487/article/details/108362021

版权

本文介绍了FastAPI中的Response Model，通过示例展示了如何使用`response_model_exclude_unset`、`response_model_include`和`response_model_exclude`来控制响应体的结构。解释了这些参数如何用于排除默认值、未设置的参数以及指定要包含或排除的字段，以确保数据安全并优化JSON响应。

摘要由CSDN通过智能技术生成

参考内容：

https://fastapi.tiangolo.com/

Response Model

还是以一个例子开头：

from typing import Optional

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()


class UserIn(BaseModel):
    username: str
    password: str
    email: EmailStr
    full_name: Optional[str] = None


# Don't do this in production!
@app.post("/user/", response_model=UserIn)
async def create_user(user: UserIn):
    return user

我们可以在下面这几个操作中用response_model参数来声明响应的模板结构:

@app.get()
@app.post()
@app.put()
@app.delete()
其他请求类型

FastAPI将使用response_model进行以下操作：

将输出数据转换为response_model中声明的数据类型。
验证数据结构和类型
将输出数据限制为该model定义的
添加到OpenAPI中
在自动文档系统中使用。

我们尝试启动上面这个例子的服务，并通过POST请求http://127.0.0.1:8000/user/，我们可以看到返回和请求体是一样的:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1sVQyk8E-1599029098971)(evernotecid://FBE381A3-17C7-41D9-AA37-9C5F29FAB396/appyinxiangcom/20545635/ENResource/p216)]

不难发现这里有一个问题，如果我们用同一个model去声明请求体参数和响应model，会造成password的泄露，那么，我们来尝试不让password返回：

from typing import Optional

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()


class UserIn(BaseModel):
    username: str
    password: str
    email: EmailStr
    full_name: Optional[str] = None


class UserOut(BaseModel):
    username: str
    email: EmailStr
    full_name: Optional[str] = None


@app.post