当前位置:
首页 > temp > python入门教程 >
-
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
其实就是response_model_exclude_unset来处理,我们看下实际的效果
那么这个时候,我们传递了呢。
可以看到,我们传递了参数就可以正常的展示,不传递参数的,我们不返回默认的值。
来源:https://www.cnblogs.com/leiziv5/p/15416384.html
最新更新
nodejs爬虫
Python正则表达式完全指南
爬取豆瓣Top250图书数据
shp 地图文件批量添加字段
爬虫小试牛刀(爬取学校通知公告)
【python基础】函数-初识函数
【python基础】函数-返回值
HTTP请求:requests模块基础使用必知必会
Python初学者友好丨详解参数传递类型
如何有效管理爬虫流量?
2个场景实例讲解GaussDB(DWS)基表统计信息估
常用的 SQL Server 关键字及其含义
动手分析SQL Server中的事务中使用的锁
openGauss内核分析:SQL by pass & 经典执行
一招教你如何高效批量导入与更新数据
天天写SQL,这些神奇的特性你知道吗?
openGauss内核分析:执行计划生成
[IM002]Navicat ODBC驱动器管理器 未发现数据
初入Sql Server 之 存储过程的简单使用
SQL Server -- 解决存储过程传入参数作为s
关于JS定时器的整理
JS中使用Promise.all控制所有的异步请求都完
js中字符串的方法
import-local执行流程与node模块路径解析流程
检测数据类型的四种方法
js中数组的方法,32种方法
前端操作方法
数据类型
window.localStorage.setItem 和 localStorage.setIte
如何完美解决前端数字计算精度丢失与数