FastAPI 学习之路（十四）响应模型-阿里云开发者社区

FastAPI 学习之路（十四）响应模型

2022-04-25 213

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： FastAPI 学习之路（十四）响应模型

系列文章：

　　FastAPI 学习之路（一）fastapi--高性能web开发框架

　　FastAPI 学习之路（二）

　　FastAPI 学习之路（三）

　　FastAPI 学习之路（四）

　　FastAPI 学习之路（五）

FastAPI 学习之路（六）查询参数，字符串的校验

　　FastAPI 学习之路（七）字符串的校验

　 FastAPI 学习之路（八）路径参数和数值的校验

　　FastAPI 学习之路（九）请求体有多个参数如何处理？

　　FastAPI 学习之路（十）请求体的字段

FastAPI 学习之路（十一）请求体 - 嵌套模型

FastAPI 学习之路（十二）接口几个额外信息和额外数据类型

我们可以在我们不同的请求路径的返回参数使用响应模型。我们看一个简单的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

我们可以看下，接口的正常返回

esponse_model是「装饰器」方法（get，post 等）的一个参数。不像之前的所有参数和请求体，它不属于路径操作函数。

它接收的类型与你将为 Pydantic 模型属性所声明的类型相同，因此它可以是一个 Pydantic 模型，但也可以是一个由 Pydantic 模型组成的 list，例如 List[Item]。

FastAPI 将使用此 response_model 来：

将输出数据转换为其声明的类型。

校验数据。

在 OpenAPI 的路径操作中为响应添加一个 JSON Schema。

并在自动生成文档系统中使用。

但最重要的是：

会将输出数据限制在该模型定义内。

我们下面做一个演示,我们正常的都应该知道，我们去创建用户的时候呢，我们的密码是明文的，我们要返回的用户信息中，不能携带我们的密码，我们应该如何处理呢，其实很简单

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