Python FastApi（7）：请求体

1 多个参数

1.1 混合使用 Path、Query 和请求体参数

        首先，毫无疑问地，你可以随意地混合使用 Path、Query 和请求体参数声明，FastAPI 会知道该如何处理。你还可以通过将默认值设置为 None 来将请求体参数声明为可选参数：

from typing import Annotatedfrom fastapi import FastAPI, Path
from pydantic import BaseModelapp = FastAPI()class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = None@app.put("/items/{item_id}")
async def update_item(item_id: Annotated[int, Path(title="The ID of the item to get", ge=0, le=1000)],q: str | None = None,item: Item | None = None,
):results = {"item_id": item_id}if q:results.update({"q": q})if item:results.update({"item": item})return results

        请注意，在这种情况下，将从请求体获取的 item 是可选的。因为它的默认值为 None。

1.2 多个请求体参数

        在上面的示例中，路径操作将期望一个具有 Item 的属性的 JSON 请求体，就像：

{"name": "Foo","description": "The pretender","price": 42.0,"tax": 3.2
}

        但是你也可以声明多个请求体参数，例如 item 和 user：

from fastapi import FastAPI
from pydantic import BaseModelapp = FastAPI()class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Noneclass User(BaseModel):username: strfull_name: str | None = None@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item, user: User):results = {"item_id": item_id, "item": item, "user": user}return results

        在这种情况下，FastAPI 将注意到该函数中有多个请求体参数（两个 Pydantic 模型参数）。因此，它将使用参数名称作为请求体中的键（字段名称），并期望一个类似于以下内容的请求体：

{"item": {"name": "Foo","description": "The pretender","price": 42.0,"tax": 3.2},"user": {"username": "dave","full_name": "Dave Grohl"}
}

        FastAPI 将自动对请求中的数据进行转换，因此 item 参数将接收指定的内容，user 参数也是如此。它将执行对复合数据的校验，并且像现在这样为 OpenAPI 模式和自动化文档对其进行记录。

1.3 请求体中的单一值

        与使用 Query 和 Path 为查询参数和路径参数定义额外数据的方式相同，FastAPI 提供了一个同等的 Body。例如，为了扩展先前的模型，你可能决定除了 item 和 user 之外，还想在同一请求体中具有另一个键 importance。

        如果你就按原样声明它，因为它是一个单一值，FastAPI 将假定它是一个查询参数。但是你可以使用 Body 指示 FastAPI 将其作为请求体的另一个键进行处理。

from typing import Annotatedfrom fastapi import Body, FastAPI
from pydantic import BaseModelapp = FastAPI()class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Noneclass User(BaseModel):username: strfull_name: str | None = None@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item, user: User, importance: Annotated[int, Body()]
):results = {"item_id": item_id, "item": item, "user": user, "importance": importance}return results

        在这种情况下，FastAPI 将期望像这样的请求体：

{"item": {"name": "Foo","description": "The pretender","price": 42.0,"tax": 3.2},"user": {"username": "dave","full_name": "Dave Grohl"},"importance": 5
}

        同样的，它将转换数据类型，校验，生成文档等。

1.4 多个请求体参数和查询参数

        当然，除了请求体参数外，你还可以在任何需要的时候声明额外的查询参数。由于默认情况下单一值被解释为查询参数，因此你不必显式地添加 Query，你可以仅执行以下操作：

q: str = None
@app.put("/items/{item_id}")
async def update_item(*,item_id: int,item: Item,user: User,importance: Annotated[int, Body(gt=0)],q: str | None = None,
):

   Body 同样具有与 Query、Path 以及其他后面将看到的类完全相同的额外校验和元数据参数。 

1.5 嵌入单个请求体参数

        假设你只有一个来自 Pydantic 模型 Item 的请求体参数 item。默认情况下，FastAPI 将直接期望这样的请求体。但是，如果你希望它期望一个拥有 item 键并在值中包含模型内容的 JSON，就像在声明额外的请求体参数时所做的那样，则可以使用一个特殊的 Body 参数 embed：

item: Item = Body(embed=True)
from typing import Annotatedfrom fastapi import Body, FastAPI
from pydantic import BaseModelapp = FastAPI()class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = None@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Annotated[Item, Body(embed=True)]):results = {"item_id": item_id, "item": item}return results

        在这种情况下，FastAPI 将期望像这样的请求体：

{"item": {"name": "Foo","description": "The pretender","price": 42.0,"tax": 3.2}
}

        而不是：

{"name": "Foo","description": "The pretender","price": 42.0,"tax": 3.2
}

2 字段

        与在路径操作函数中使用 Query、Path 、Body 声明校验与元数据的方式一样，可以使用 Pydantic 的 Field 在 Pydantic 模型内部声明校验和元数据。首先，从 Pydantic 中导入 Field：

from typing import Annotatedfrom fastapi import Body, FastAPI
from pydantic import BaseModel, Field

        然后，使用 Field 定义模型的属性：

class Item(BaseModel):name: strdescription: str | None = Field(default=None, title="The description of the item", max_length=300)price: float = Field(gt=0, description="The price must be greater than zero")tax: float | None = None@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Annotated[Item, Body(embed=True)]):results = {"item_id": item_id, "item": item}return results

   模型属性的类型、默认值及 Field 的代码结构与路径操作函数的参数相同，只不过是用 Field 替换了Path、Query、Body。

3 嵌套模型

        使用 FastAPI，你可以定义、校验、记录文档并使用任意深度嵌套的模型（归功于Pydantic）。

3.1 List 字段

        你可以将一个属性定义为拥有子元素的类型。例如 Python list：

class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonetags: list = []

        这将使 tags 成为一个由元素组成的列表。不过它没有声明每个元素的类型。Python 有一种特定的方法来声明具有子类型的列表：

from typing import List, Unionfrom fastapi import FastAPI
from pydantic import BaseModelapp = FastAPI()class Item(BaseModel):name: strdescription: Union[str, None] = Noneprice: floattax: Union[float, None] = Nonetags: List[str] = []

        这完全是用于类型声明的标准 Python 语法。对具有子类型的模型属性也使用相同的标准语法。因此，在我们的示例中，我们可以将 tags 明确地指定为一个「字符串列表」。

3.2 Set 类型

        Python 具有一种特殊的数据类型来保存一组唯一的元素，即 set。然后我们可以导入 Set 并将 tag 声明为一个由 str 组成的 set：

class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonetags: set[str] = set()

        这样，即使你收到带有重复数据的请求，这些数据也会被转换为一组唯一项。而且，每当你输出该数据时，即使源数据有重复，它们也将作为一组唯一项输出。并且还会被相应地标注 / 记录文档。

3.3 嵌套模型

        Pydantic 模型的每个属性都具有类型。但是这个类型本身可以是另一个 Pydantic 模型。因此，你可以声明拥有特定属性名称、类型和校验的深度嵌套的 JSON 对象。上述这些都可以任意的嵌套。例如，我们可以定义一个 Image 模型：

class Image(BaseModel):url: strname: str

        然后我们可以将其用作一个属性的类型：

class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonetags: set[str] = set()image: Image | None = None

        这意味着 FastAPI 将期望类似于以下内容的请求体：

{"name": "Foo","description": "The pretender","price": 42.0,"tax": 3.2,"tags": ["rock", "metal", "bar"],"image": {"url": "http://example.com/baz.jpg","name": "The Foo live"}
}

        再一次，仅仅进行这样的声明，你将通过 FastAPI 获得：

  • 对被嵌入的模型也适用的编辑器支持（自动补全等）
  • 数据转换
  • 数据校验
  • 自动生成文档

3.4 特殊的类型和校验

        除了普通的单一值类型（如 str、int、float 等）外，你还可以使用从 str 继承的更复杂的单一值类型。例如，在 Image 模型中我们有一个 url 字段，我们可以把它声明为 Pydantic 的 HttpUrl，而不是 str：

from fastapi import FastAPI
from pydantic import BaseModel, HttpUrlapp = FastAPI()class Image(BaseModel):url: HttpUrlname: str

        该字符串将被检查是否为有效的 URL，并在 JSON Schema / OpenAPI 文档中进行记录。

3.5 带有一组子模型的属性

        你还可以将 Pydantic 模型用作 list、set 等的子类型：

class Image(BaseModel):url: HttpUrlname: strclass Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonetags: set[str] = set()images: list[Image] | None = None

        这将期望（转换，校验，记录文档等）下面这样的 JSON 请求体：

{"name": "Foo","description": "The pretender","price": 42.0,"tax": 3.2,"tags": ["rock","metal","bar"],"images": [{"url": "http://example.com/baz.jpg","name": "The Foo live"},{"url": "http://example.com/dave.jpg","name": "The Baz"}]
}

3.6 深度嵌套模型

        你可以定义任意深度的嵌套模型：

class Image(BaseModel):url: HttpUrlname: strclass Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonetags: set[str] = set()images: list[Image] | None = Noneclass Offer(BaseModel):name: strdescription: str | None = Noneprice: floatitems: list[Item]

3.7 纯列表请求体

        如果你期望的 JSON 请求体的最外层是一个 JSON array（即 Python list），则可以在路径操作函数的参数中声明此类型，就像声明 Pydantic 模型一样：

images: List[Image]
from fastapi import FastAPI
from pydantic import BaseModel, HttpUrlapp = FastAPI()class Image(BaseModel):url: HttpUrlname: str@app.post("/images/multiple/")
async def create_multiple_images(images: list[Image]):return images

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/bicheng/75153.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

告别枯燥工作，走向自动化

告别枯燥工作，走向自动化

嘿，小伙伴们！今天给你们介绍两款超实用的RPA办公自动化软件，用它们，再也不用像机器一样做重复劳动啦，超省时间！ 工具名称：影刀RPA（类似产品，八爪鱼 RPA，操作上…
阅读更多...
一种C# Winform的UI处理

一种C# Winform的UI处理

效果 圆角 阴影 突出按钮 说明 这是一种另类的处理，不是多层窗口 也不是WPF 。这种方式的特点是比较简单，例如圆角、阴影、按钮等特别容易修改过。其实就是html css DirectXForm。 在VS中如下 圆角和阴影 然后编辑这个窗体的Html模板&#xff0c…
阅读更多...
HarmonyOS-ArkUI Navigation (导航组件)-第一部分

HarmonyOS-ArkUI Navigation (导航组件)-第一部分

导航组件主要实现页面间以及组件内部的界面跳转，支持在不同的组件间进行参数的传递，提供灵活的跳转栈操作，从而便捷的实现对不同页面的访问和复用。 我们之前学习过Tabs组件，这个组件里面也有支持跳转的方式，Navigati…
阅读更多...
华为开源自研AI框架昇思MindSpore应用案例：基于MindSpore框架实现PWCNet光流估计

华为开源自研AI框架昇思MindSpore应用案例：基于MindSpore框架实现PWCNet光流估计

如果你对MindSpore感兴趣，可以关注昇思MindSpore社区 1 环境准备 1.进入ModelArts官网 云平台帮助用户快速创建和部署模型，管理全周期AI工作流，选择下面的云平台以开始使用昇思MindSpore，可以在昇思教程中进入ModelArts官网 创建…
阅读更多...
虚幻基础：UI

虚幻基础：UI

文章目录 控件蓝图可以装载其他控件蓝图可以安装其他蓝图接口 填充：相对于父组件填充水平框尺寸—填充—0.5：改变填充的尺寸填充—0.5：改变与父组件的距离 锚点：相对于父组件的控件坐标系原点，屏幕比例改变时&#xff…
阅读更多...
监控平台——SkyWalking部署

监控平台——SkyWalking部署

一、环境准备 先下载SkyWalking安装包，需要注意的是SkyWalking 版本在10.X以上使用的nacos-client是2.X，如果安装的Nacos版本是1.X就会存在兼容性的问题。由于本人使用的SpringBoot项目是2.7.X版本，安装的Nacos版本只能是1.X版本的&#xff…
阅读更多...
热门索尼S-Log3电影感氛围旅拍LUTS调色预设 Christian Mate Grab - Sony S-Log3 Cinematic LUTs

热门索尼S-Log3电影感氛围旅拍LUTS调色预设 Christian Mate Grab - Sony S-Log3 Cinematic LUTs

热门索尼S-Log3电影感氛围旅拍LUTS调色预设 Christian Mate Grab – Sony S-Log3 Cinematic LUTs 我们最好的 Film Look S-Log3 LUT 的集合，适用于索尼无反光镜相机。无论您是在户外、室内、风景还是旅行电影中拍摄，这些 LUT 都经过优化，可为…
阅读更多...
自动化工作流工具的综合对比与推荐

自动化工作流工具的综合对比与推荐

最近收到很多朋友私信我说：“刷短视频的时候，总是刷到自动化工作流的工具，有好多直播间都在宣传，不知道哪款工具好”。我花了点时间，做了一下测试，大家可以参考一下，以下内容： 以下…
阅读更多...
fircrawl本地部署

fircrawl本地部署

企业内部的网站作为知识库给dify使用，使用fircrawl来爬虫并且转换为markdown。 ​ git clone https://github.com/mendableai/firecrawl.gitcd ./firecrawl/apps/api/ cp .env.example .env cd ~/firecrawl docker compose up -d 官方： https://githu…
阅读更多...
day17 学习笔记

day17 学习笔记

文章目录 前言一、数组的增删改查1.resize函数2.append函数3.insert函数4.delete函数5.argwhere函数6.unique函数 二、统计函数1.amax，amin函数2.ptp函数3.median函数4.mean函数5.average函数6.var，std函数 前言 通过今天的学习，我掌握了num…
阅读更多...
CentOS 8 Stream 配置在线yum源参考 —— 筑梦之路

CentOS 8 Stream 配置在线yum源参考 —— 筑梦之路

CentOS 8 Stream ISO 文件下载地址：http://mirrors.aliyun.com/centos-vault/8-stream/isos/x86_64/CentOS-Stream-8-20240603.0-x86_64-dvd1.isoCentOS 8 Stream 网络引导ISO 文件下载地址：http://mirrors.aliyun.com/centos-vault/8-stream/isos/x86_6…
阅读更多...
网络原理-TCP/IP

网络原理-TCP/IP

网络原理学习笔记：TCP/IP 核心概念 本文是我在学习网络原理时整理的笔记，主要涵盖传输层、网络层和数据链路层的核心协议和概念，特别是 TCP, UDP, IP, 和以太网。 一、传输层 (Transport Layer) 传输层负责提供端到端（进程到进…
阅读更多...
EF Core 执行原生SQL语句

EF Core 执行原生SQL语句

文章目录 前言一、执行查询&#xff08;返回数据&#xff09;1&#xff09; 使用 FromSqlRaw或 FromSqlInterpolated 方法&#xff0c;适用于 DbSet<T>&#xff0c;返回实体集合。2&#xff09;结合 LINQ 查询3&#xff09;执行任意原生SQL查询语句&#xff08;使用ADO.N…
阅读更多...
Unity LOD Group动态精度切换算法（基于视锥+运动速度）技术详解

Unity LOD Group动态精度切换算法（基于视锥+运动速度）技术详解

一、动态LOD技术背景与核心挑战 1. 传统LOD系统的局限 静态阈值切换&#xff1a;仅基于距离的切换在动态场景中表现不佳 视觉突变&#xff1a;快速移动时LOD层级跳变明显 性能浪费&#xff1a;静态算法无法适应复杂场景变化 对惹&#xff0c;这里有一个游戏开发交流小组&…
阅读更多...
MyBatis复杂查询——一对一、一对多

MyBatis复杂查询——一对一、一对多

目录 &#xff08;一&#xff09;复杂查询&#xff1a;1对1关系 【任务】数据库里有学生表(student)和学生证信息表(student_card)&#xff0c;表结构如下所示&#xff0c;要求使用MyBatis框架查询所有的学生信息以及每位学生的学生证信息 解决方案1&#xff1a;关联查询实现…
阅读更多...
【服务端】使用conda虚拟环境部署Django项目

【服务端】使用conda虚拟环境部署Django项目

写在开头 为了与客户端的Deep search配合&#xff0c;需要整一个后台管理来保存和管理deep search的数据资料。选择前端框架Vue-Vben-Admin Django后台服务来实现这个项目。 废话结束&#xff0c;从零开始。。。。 一、环境搭建 1. 安装 Anaconda 下载 Anaconda&#xff1…
阅读更多...
Python爬虫-爬取大麦网演出详情页面数据

Python爬虫-爬取大麦网演出详情页面数据

前言 本文是该专栏的第50篇，后面会持续分享python爬虫干货知识，记得关注。 本文，笔者以大麦网平台为例。基于Python，实现获取演出详情页面的演出信息。 废话不多说，具体实现思路和详细逻辑，笔者将在正文结合完整代码进行详细介绍。接下来，跟着笔者直接往下看正文详细内…
阅读更多...
多onnx模型导出合并调研（文本检测+方向分类+文本识别）

多onnx模型导出合并调研（文本检测+方向分类+文本识别）

👑主页：吾名招财 👓简介：工科学硕，研究方向机器视觉，爱好较广泛… ​💫签名：面朝大海，春暖花开！ 多onnx模型合并导出调研（文本检测+方向分类+文本识别） 引言1，尝试合并两个模型（文本方向分类+文本识别模型）（并行合并）（1）文本方向分类（2）文本识别模型（…
阅读更多...
Flink介绍——实时计算核心论文之S4论文详解

Flink介绍——实时计算核心论文之S4论文详解

引入 在上一篇我们对Flink的发展历史有了全局的了解&#xff0c;下面我们会通读几篇分布式实时处理相关的重要论文&#xff0c;从S4到Storm&#xff0c;再从MillWheel到Dataflow&#xff0c;最后到Flink。 通过深入梳理分布式实时处理技术的发展脉络&#xff0c;了解这些年技…
阅读更多...
【商城实战(97)】ELK日志管理系统的全面应用

【商城实战(97)】ELK日志管理系统的全面应用

【商城实战】专栏重磅来袭！这是一份专为开发者与电商从业者打造的超详细指南。从项目基础搭建，运用 uniapp、Element Plus、SpringBoot 搭建商城框架，到用户、商品、订单等核心模块开发，再到性能优化、安全加固、多端适配，乃至运营推广策略，102 章内容层层递进。无论是想…
阅读更多...
最新文章

Copyright @ 2022~2023