【Python开发】FastAPI 03：请求参数—请求体

除了路径参数和查询参数，还有请求体，其用于传递 JSON、XML 或其他格式的数据，以便服务器能够读取并做出相应的处理，可以说请求体的作用更为强大。试想一下，如果存在七八个参数，路径参数和查询是不是就招架不住了，但是请求体则可以将这七八个参数一网打尽。

目录

1 声明请求体

1.1 使用 Pydantic 模型

① 创建数据模型

② 声明为参数

③ 请求体 + 路径参数 + 查询参数

④ 数据模型使用 Field

1.2 使用 Body

① 单一值的请求体

② 嵌入单个请求体参数

2 请求体中的嵌套模型

2.1 List 字段

① 未声明元素类型

② 声明元素类型

2.2 Set 类型

2.3 嵌套模型 

2.4 特殊的类型和校验

① HttpUrl

② 纯列表请求体

3 额外数据类型及参数

3.1 其他数据类型

3.2 Cookie 参数

3.3 Header 参数

① 声明 Header 参数

② 自动转换

1 声明请求体

当需要将数据从客户端（例如浏览器）发送给 API（可以理解为是应用后台）时，你将其作为「请求体」发送。

请求体是客户端发送给 API 的数据，响应体是 API 发送给客户端的数据。

你不能使用 GET 操作（HTTP 方法）发送请求体。
要发送请求体，必须使用下列方法之一：POST（较常见）、PUT、DELETE 或 PATCH。

1.1 使用 Pydantic 模型

① 创建数据模型

# 导入 Pydantic 的 BaseModel
from pydantic import BaseModel

#将数据模型声明为继承自 BaseModel 的类,使用标准的 Python 类型来声明所有属性
class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None

类似查询参数，某字段若非必须，可为其设置一个默认值或可选 None，否则该字段就是必须的。

上面的模型声明了一个这样的 JSON「object」（或 Python dict）：

{
    "name": "Foo",
    "description": "An optional description",
    "price": 45.2,
    "tax": 3.5
}

因为 description 和 tax 是可选的（它们的默认值为 None），那么下面的 JSON「object」也是有效的：

{
    "name": "Foo",
    "price": 45.2
}

② 声明为参数

类似路径参数和查询参数，可以使用相同的方式声明请求体，并且将它的类型声明为你创建的 Item 模型，完整代码：

from typing import Union
from fastapi import FastAPI
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None

app = FastAPI()

@app.post("/items1/")
async def create_item(item: Item):
    return item

此时，我们可以使用交互文档、postman、apifox等工具进行请求测试，后边将使用交互文档进行测试。

仅仅使用了 Python 类型声明，FastAPI 将做以下事情：

  • 将请求体作为 JSON 读取。
  • 校验数据。
  • 如果数据无效，将返回一条清晰易读的错误信息，指出不正确数据的确切位置和内容。
  • 将接收的数据赋值到参数 item 中。
  • 这些模式将成为生成的 OpenAPI 模式的一部分，并且被自动化文档 UI 所使用。

在函数内部，你可以直接访问模型对象的所有属性：

...

@app.post("/items2/")
async def create_item(item: Item):
    item_dict = item.dict()
    if item.tax:
        price_with_tax = item.price + item.tax
        item_dict.update({"price_with_tax": price_with_tax})
    return item_dict

📌 文档

你所定义模型的 JSON 模式将可以在交互式 API 文档中展示：

③ 请求体 + 路径参数 + 查询参数

你还可以同时声明请求体、路径参数和查询参数。

...

@app.put("/items3/{item_id}")
async def create_item(item_id: int, item: Item, q: Union[str, None] = None):
    result = {"item_id": item_id, **item.dict()}
    if q:
        result.update({"q": q})
    return result

请求参数将依次按如下规则进行识别：

  • 如果在路径中也声明了该参数，它将被用作路径参数。
  • 如果参数属于单一类型（比如 int、float、str、bool 等）它将被解释为查询参数。
  • 如果参数的类型被声明为一个 Pydantic 模型，它将被解释为请求体。

④ 数据模型使用 Field

与使用 Query、Path 类似，你可以使用 Pydantic 的 Field 在 Pydantic 模型内部声明校验和元数据。

from typing import Union
from fastapi import FastAPI
from pydantic import BaseModel, Field #导入 Field

app = FastAPI()

class Item1(BaseModel): #对模型属性使用 Field
    name: str
    description: Union[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: Union[float, None] = None

@app.put("/items4/{item_id}")
async def update_item(item_id: int, item: Item1):
    results = {"item_id": item_id, "item": item}
    return results

Field 的工作方式和 Query 和 Path 相同，包括它们的参数等等也完全相同，详情可以查看上一章内容~

1.2 使用 Body

与使用 Query 和 Path 为查询参数和路径参数定义额外数据的方式相同，FastAPI 提供了一个同等的 Body。

① 单一值的请求体

如果该请求参数是一个单一值（比如 str、int 等），但是依旧想让他以请求体的形式存在，那么可以使用 Body 来修饰，不然系统将默认他是一个查询参数。

from typing import Union

from fastapi import Body, FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    username: str
    full_name: Union[str, None] = None

@app.put("/items5/{item_id}")
async def update_item(item_id: int, user: User, single: int = Body()):
    results = {"item_id": item_id, "user": user, "single": single}
    return results

此时，FastAPI 期望的请求体如下：

{
    "user": {
        "username": "yinyu",
        "full_name": "yinyuyu"
    },
    "single": 5
}

② 嵌入单个请求体参数

如果你想要这个 JSON 外再带一个 key，那么可以使用嵌入的特殊 Body 参数：

user: User = Body(embed=True)

比如：

...

@app.put("/items6/{item_id}")
async def update_item(item_id: int, user: User = Body(embed=True)):
    results = {"item_id": item_id, "user": user}
    return results

此时，FastAPI 期望的请求体如下：

{
    "user": {
        "username": "yinyu",
        "full_name": "yinyuyu"
    }
}

而不是：

{
    "username": "yinyu",
    "full_name": "yinyuyu"
}

2 请求体中的嵌套模型

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

2.1 List 字段

① 未声明元素类型

你可以将一个请求体模型的属性/字段定义为拥有子元素的类型。例如 Python list：

from typing import List, Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Model1(BaseModel):
    name: str
    price: float
    tags: list = []

@app.put("/model1/{model_id}")
async def update_model(model_id: int, model: Model1):
    results = {"model_id": model_id, "model": model}
    return results

此时，FastAPI 期望的请求体可以如下：

{
  "name": "string",
  "price": 0,
  "tags": [1, "yinyu"]
}

因为 tags 只是一个由元素组成的列表，它没有声明每个元素的类型，因此可以放多个类型的元素进去。

② 声明元素类型

如果我们想指定列表中的元素类型，那么 Python 也提供了一种特定的方法：

要声明具有子类型的类型，例如 list、dict、tuple：

  1. 从 typing 模块导入它们
  2. 使用方括号 [  ] 将子类型作为「类型参数」传入
from typing import List

my_list: List[str]

因此，在我们的示例中，我们可以将 tags 明确地指定为一个「字符串列表」：

...

class Model2(BaseModel):
    name: str
    price: float
    tags: List[str] = [] #声明具有子类型的列表,要声明具有子类型的类型，例如 list、dict、tuple：

@app.put("/model2/{model_id}")
async def update_model(model_id: int, model: Model2):
    results = {"model_id": model_id, "model": model}
    return results

2.2 Set 类型

如果你希望列表中的元素不能重复，那么 set 这一数据类型可以很好的满足该要求：

from typing import Set, Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Model3(BaseModel):
    name: str
    price: float
    mtags: Set[str] = set()

@app.put("/model3/{model_id}")
async def update_model(model_id: int, model: Model3):
    results = {"model_id": model_id, "model": model}
    return results

此时，FastAPI 期望的请求体可以如下：

{
  "name": "yinyu",
  "price": 0,
  "mtags": ["handsome","handsome"]
}

正确请求后的响应内容则如下：

{
  "model_id": 1,
  "model": {
    "name": "string",
    "price": 0,
    "mtags": ["1"]
  }
}

这样，即使你收到带有重复数据的请求，后台也会将重复元素进行筛选后保留一项。

2.3 嵌套模型 

Pydantic 模型的每个属性/字段都具有类型，那么你可以使得该属性也是一个 Pydantic 模型

from typing import Union
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

#定义一个 Image 模型作为子模型
class Image(BaseModel):
    url: str
    name: str

class Base1(BaseModel):
    name: str
    description: Union[str, None] = None
    image: Union[Image, None] = None #将子模型用作类型

@app.put("/base1/{base_id}")
async def update_base(base_id: int, base: Base1):
    results = {"item_id": base_id, "item": base}
    return results

此时，FastAPI 期望的请求体可以如下：

{
    "name": "yinyu",
    "description": "The pretender",
    "image": {
        "url": "http://yinyu.com",
        "name": "The yinyu live"
    }
}

2.4 特殊的类型和校验

① HttpUrl

在 Image 模型中我们有一个 url 字段，我们可以把它声明为 Pydantic 的 HttpUrl，而不是 str，类似的特殊类型可以在 Field Types - Pydantic 页面查看。

from pydantic import BaseModel, HttpUrl

class Image(BaseModel):
    url: HttpUrl
    name: str

② 纯列表请求体

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

from typing import List

from fastapi import FastAPI
from pydantic import BaseModel, HttpUrl

app = FastAPI()

class Image(BaseModel):
    url: HttpUrl
    name: str

@app.post("/images/multiple/")
async def create_multiple_images(images: List[Image]):
    return images

此时，FastAPI 期望的请求体可以如下 👇，可以有 n 个 Image。

[
  {
    "url": "www.11.com",
    "name": "yin"
  },
  {
    "url": "www.22.com",
    "name": "yu"
  }
]

3 额外数据类型及参数

3.1 其他数据类型

Python 同样支持更复杂的数据类型：

  • UUID:
    • 一种标准的 "通用唯一标识符" ，在许多数据库和系统中用作ID。
    • 在请求和响应中将以 str 表示。
  • datetime.datetime:
    • 一个 Python datetime.datetime.
    • 在请求和响应中将表示为 ISO 8601 格式的 str ，比如: 2008-09-15T15:53:00+05:00.
  • datetime.date:
    • Python datetime.date.
    • 在请求和响应中将表示为 ISO 8601 格式的 str ，比如: 2008-09-15.
  • datetime.time:
    • 一个 Python datetime.time.
    • 在请求和响应中将表示为 ISO 8601 格式的 str ，比如: 14:23:55.003.
  • datetime.timedelta:
    • 一个 Python datetime.timedelta.
    • 在请求和响应中将表示为 float 代表总秒数。
    • Pydantic 也允许将其表示为 "ISO 8601 时间差异编码", 查看文档了解更多信息。
  • frozenset:
    • 在请求和响应中，作为 set 对待：
    • 在请求中，列表将被读取，消除重复，并将其转换为一个 set。
    • 在响应中 set 将被转换为 list 。
    • 产生的模式将指定那些 set 的值是唯一的 (使用 JSON 模式的 uniqueItems)。
  • bytes:
    • 标准的 Python bytes。
    • 在请求和相应中被当作 str 处理。
    • 生成的模式将指定这个 str 是 binary "格式"。
  • Decimal:
    • 标准的 Python Decimal。
    • 在请求和相应中被当做 float 一样处理。

比如下面的例子，就使用了上述的一些类型：

@app.put("/items/{item_id}")
async def read_items(
    item_id: UUID,
    start_datetime: Union[datetime, None] = Body(default=None),
    end_datetime: Union[datetime, None] = Body(default=None),
    repeat_at: Union[time, None] = Body(default=None),
    process_after: Union[timedelta, None] = Body(default=None),
):
    start_process = start_datetime + process_after
    duration = end_datetime - start_process
    return {
        "item_id": item_id,
        "start_datetime": start_datetime,
        "end_datetime": end_datetime,
        "repeat_at": repeat_at,
        "process_after": process_after,
        "start_process": start_process,
        "duration": duration,
    }

其中函数内的参数有原生的数据类型，可以执行正常的日期操作。

3.2 Cookie 参数

声明 Cookie 参数的结构与声明 Query 参数和 Path 参数时相同，第一个值是参数的默认值，同时也可以传递所有验证参数或注释参数，来对 Cookie 参数进行校验：

from typing import Union

from fastapi import Cookie, FastAPI

app = FastAPI()

@app.get("/items1/")
async def read_items(ads_id: Union[str, None] = Cookie(default=None)):
    return {"ads_id": ads_id}

必须使用 Cookie 来声明 cookie 参数，否则参数将会被解释为查询参数。

3.3 Header 参数

你可以使用定义 Query、Path 和 Cookie 参数一样的方法定义 Header 参数。

① 声明 Header 参数

同样，第一个值是默认值，你可以传递所有的额外验证或注释参数：

from typing import Union

from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/items2/")
async def read_items(user_agent: Union[str, None] = Header(default=None)):
    return {"User-Agent": user_agent}

必须使用 Header 来声明 Header 参数，否则参数将会被解释为查询参数。

② 自动转换

大多数标准的 headers （请求头）用 "连字符" 分隔，比如 user-agent，但是像这样的变量在 Python 中是无效的。因此, 默认情况下, Header 将把参数名称的字符从下划线 (_) 转换为连字符 (-) 来提取并记录 headers。

同时，HTTP headers 是大小写不敏感的，你可以像通常在 Python 代码中那样使用 user_agent ，而不需要将首字母大写为 User_Agent 或类似的东西。

如果出于某些原因，你需要禁用下划线到连字符的自动转换，那么可设置 Header 的参数 convert_underscores 为 False:

from typing import Union

from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/items/")
async def read_items(
    strange_header: Union[str, None] = Header(default=None, convert_underscores=False)
):
    return {"strange_header": strange_header}

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Android播放器拖动进度条的小图预览

Android播放器拖动进度条的小图预览

Android播放器拖动进度条的小图预览 背景效果图关键代码1. 获取指定位置的视频帧2. 预览图的显示和隐藏 完整代码1. xml布局文件activity_video.xml2. Activity文件VideoActivity.java 背景 我们在使用一些播放器时，拖动进度条会有一个预览框，上一篇博客…
阅读更多...
Docker容器 和 Kubernetes容器集群管理系统

Docker容器 和 Kubernetes容器集群管理系统

一、快速了解Docker 1. 什么是Docker的定义 Docker 是一个开源的应用容器引擎，基于Go语言并遵从 Apache2.0 协议开源。Docker 可以让开发者打包他们的应用以及依赖包到一个轻量级、可移植的容器中，然后发布到任何流行的 Linux 机器上，也可以…
阅读更多...
javaScript 给图片加水印

javaScript 给图片加水印

背景 在很多地方，我们都可以看到，上传图片的时候，图片都会被加上默认的水印，水印的作用主要体现在以下几个方面： 1.版权保护：在商业用途的照片中添加水印可以帮助保护作者的版权，防止他人未经…
阅读更多...
IOS复杂震动AHAP文件编辑指南

IOS复杂震动AHAP文件编辑指南

简介 目前部分游戏会在播放一些特定的音乐音效时，令设备产生贴合音效的复杂震动，给玩家一个更好的游戏体验。这种复杂震动就是通过苹果的CoreHaptics库实现的。 下面是关于CoreHaptics的官方文档 ​​​​​​​Core Haptics | Apple Developer Docum…
阅读更多...
C++ Qt项目实战：构建高效的代码管理器

C++ Qt项目实战：构建高效的代码管理器

C Qt项目实战：构建高效的代码管理器 一、项目概述（Introduction）1.1 项目背景（Project Background）1.2 项目目标（Project Goals）1.3 项目应用场景（Project Application Scenarios&am…
阅读更多...
《操作系统》期末主观题梳理

《操作系统》期末主观题梳理

操作系统简答题 文章目录 操作系统简答题第一章第二章第三章第四章第五章第六章第七章第八章第九章 第一章 在计算机系统上配置OS(operating system, 操作系统)的目标是什么?作用主要表现在哪几个方面? 在计算机系统上配置OS, 主要目标是实现：方便性、有效性、可…
阅读更多...
加速数实融合，数据交易3.0模式上新

加速数实融合，数据交易3.0模式上新

数据交易市场将迎来真正的突破？ 目前看的确如此。随着去年底“数据二十条”的颁布，业界普遍认为数据基础制度将加速走向落地与完善，数据要素化今年有望迎来全面提速，将极大促进数据交易市场走向规模化。 IDC预测，到2…
阅读更多...
css3新增特性

css3新增特性

1. 初始化 <!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><meta http-equiv"X-UA-Compatible" content"IEedge"><meta name"viewport" content"widthdevice-width, …
阅读更多...
【Cpp】哈希之手撕闭散列/开散列

【Cpp】哈希之手撕闭散列/开散列

文章目录 unorderedunordered系列关联式容器unordered_map和unordered_set概述unordered_map的文档介绍unordered_map的接口说明 底层结构 哈希哈希/散列表 概念哈希冲突哈希函数哈希函数设计原则&#xff1a;常见哈希函数 哈希冲突解决闭散列线性探测二次探测 开散列 哈希表的…
阅读更多...
mysql学习

mysql学习

DISTINCT 检索不同行 该关键字的作用就是用来去重&#xff0c;可以将你所要展示的数据中完全相同的去重&#xff0c;只展示一个&#xff1b; LIMIT 限制结果 该关键字的作用就是你限制它返回几条数据&#xff0c;比如你想要获得前面5行的据&#xff0c;就可以使用limit 5&…
阅读更多...
java 区分缺陷Defects/感染Infections/失败Failure

java 区分缺陷Defects/感染Infections/失败Failure

java 区分缺陷Defects/感染Infections/失败Failure 缺陷Defects 软件故障总是从代码中一个或多个缺陷的执行开始。 缺陷只是一段有缺陷、不正确的代码。 缺陷可能是程序语句的一部分或完整部分&#xff0c;也可能对应于不存在但应该存在的语句。 尽管程序员要对代码中的缺陷负…
阅读更多...
利用Servlet编写第一个“hello world“(续)

利用Servlet编写第一个“hello world“(续)

利用Servlet编写第一个“hello world“ &#x1f50e;通过插件 Smart Tomcat 简化 打包代码 与 部署 操作下载Smart Tomcat配置Smart Tomcat &#x1f50e;Servlet 中的常见错误404(Not Found)&#x1f36d;请求路径出错&#x1f36d;war 包未被正确加载 405(Method Not Allowe…
阅读更多...
【ChatGPT】ChatGPT自动生成思维导图

【ChatGPT】ChatGPT自动生成思维导图

参考视频&#xff1a;https://edu.csdn.net/learn/38346/613917 应用场景&#xff1a;自学&#xff0c;“研一学生如何学习机器学习”的思维导图 问&#xff1a;写一个“研一学生如何学习机器学习”的思维导图内容&#xff0c;以markdown代码块格式输出 # 研一学生如何学习…
阅读更多...
统计学的假设检验/置信区间计算

统计学的假设检验/置信区间计算

假设检验的核心其实就是反证法。反证法是数学中的一个概念&#xff0c;就是你要证明一个结论是正确的&#xff0c;那么先假设这个结论是错误的&#xff0c;然后以这个结论是错误的为前提条件进行推理&#xff0c;推理出来的结果与假设条件矛盾&#xff0c;这个时候就说明这个假…
阅读更多...
《JavaEE》HTTPS

《JavaEE》HTTPS

文章目录 HTTPS起源HTTPS对称加密非对称加密两者的区别 HTTPS的安全问题使用对称加密正常交互黑客入侵解决方案 非对称加密引入非对称加密后的流程 中间人攻击黑客的入侵方案加入后的流程解决方案黑客再次加注解决方案 ​&#x1f451;作者主页&#xff1a;Java冰激凌 &#x1…
阅读更多...
毫米波雷达信号处理中的通道间相干与非相干积累问题

毫米波雷达信号处理中的通道间相干与非相干积累问题

说明 相干和非相干积累是雷达信号处理中的常用方法&#xff0c;这两个概念一般是用在多脉冲积累这个问题上&#xff1a;积累可以提高信号的SNR&#xff0c;从而提高检出概率。不过本文内容与脉冲积累无关&#xff0c;本文讨论的话题是将这两个概念(non-coherent combination、c…
阅读更多...
HCIA-MSTP替代技术之链路捆绑（LACP模式）

HCIA-MSTP替代技术之链路捆绑（LACP模式）

目录 手工链路聚合的不足&#xff1a; LACP链路聚合的原理 LACP模式&#xff1a; LACPDU&#xff1a; 1&#xff0c;设备优先级&#xff1a; 设备优先级的比较是&#xff1a;先比较优先级大小&#xff0c;0到32768&#xff0c;越小优先级越高&#xff0c;如果优先级相同&a…
阅读更多...
OpenAI再出新作，AIGC时代，3D建模师的饭碗危险了！

OpenAI再出新作，AIGC时代，3D建模师的饭碗危险了！

大家好&#xff0c;我是千与千寻&#xff0c;也可以叫我千寻哥&#xff0c;说起来&#xff0c;自从ChatGPT发布之后&#xff0c;我就开始焦虑&#xff0c;担心自己程序员的饭碗会不会哪天就被AIGC取代了。 有人说我是过度焦虑了&#xff0c;但是我总觉有点危机感肯定没有坏处。…
阅读更多...
【017】C++ 指针变量详解，理解指针变量

【017】C++ 指针变量详解，理解指针变量

C 指针变量详解 引言一、内存概述二、指针变量2.1、地址和指针变量的关系2.2、定义指针变量2.3、指针变量的初始化2.4、指针类型2.5、案例2.6、注意事项 三、数组元素的指针3.1、概述3.2、在使用中 [ ] 就是 *()的缩写3.3、指向同一数组的元素的两个指针变量间的关系 四、字符串…
阅读更多...
UOS桌面系统使用RLinux恢复数据

UOS桌面系统使用RLinux恢复数据

UOS桌面系统使用RLinux恢复数据 一、工具介绍二、注意事项三、准备四、制作live系统启动盘五、拷贝文件六、进入live系统一、工具介绍 R-Linux 是一款用于 Linux 和某些 Unixes 操作系统 Ext2/Ext3/Ext4 FS 文件系统的免费文件恢复实用工具。R-Linux 与 R-Studio 使用相同的 I…
阅读更多...
最新文章

Copyright @ 2022~2023