当你需要将数据从客户端（例如浏览器）发送给 API时，你将其作为「请求体」发送。

FastAPI 使用**请求体**从客户端（例如浏览器）向 API发送数据。

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

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

你的API几乎总是要发送**响应**体。但是客户端并不总是需要发送**请求**体。

API基本上总要发送**响应体**，但是客户端不一定发送**请求体**。

我们使用 <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>模型来声明**请求**体，并能够获得它们所具有的所有能力和优点。

使用 <ahref="https://pydantic-docs.helpmanual.io/"class="external-link"target="_blank">Pydantic</a>模型声明**请求体**，可以充分利用它的功能和优点。

!!! info

你不能使用`GET` 操作（HTTP 方法）发送请求体。

!!! info "说明"

首先，你需要从`pydantic` 中导入`BaseModel`：

首先，从`pydantic` 中导入`BaseModel`：

```Python hl_lines="2"

```Python hl_lines="4"

{!../../../docs_src/body/tutorial001.py!}

然后，将你的数据模型声明为继承自`BaseModel` 的类。

然后，把数据模型声明为继承自`BaseModel` 的类。

使用标准的 Python类型来声明所有属性：

使用 Python标准类型声明所有属性：

```Python hl_lines="5-9"

```Python hl_lines="7-11"

{!../../../docs_src/body/tutorial001.py!}

和声明查询参数时一样，当一个模型属性具有默认值时，它不是必需的。否则它是一个必需属性。将默认值设为`None` 可使其成为可选属性。

包含默认值的模型属性与声明查询参数一样，不是必选的。没有默认值的模型属性是必选的。模型属性的默认值设为`None`，则为可选。

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

例如，上述模型声明了如下 JSON「对象」（也是 Python 的`dict`）：

{

}

...由于`description` 和`tax` 是可选的（它们的默认值为`None`），下面的 JSON「`object`」也将是有效的：

……由于`description` 和`tax` 是可选的（默认值为`None`），下面的 JSON「对象」也有效：

{

}

使用与声明路径和查询参数的相同方式声明请求体，即可将其添加到「路径操作」中：

使用与声明路径和查询参数相同的方式声明请求体，就可以把请求体添加至*路径操作*：

```Python hl_lines="16"

```Python hl_lines="18"

{!../../../docs_src/body/tutorial001.py!}

...并且将它的类型声明为你创建的`Item` 模型。

……此处，请求体参数的类型为`Item` 模型。

仅仅使用了 Python 类型声明，**FastAPI**将会：

仅使用 Python 类型声明，**FastAPI**就可以：

*将请求体作为 JSON读取。

*转换为相应的类型（在需要时）。

* 校验数据。

*如果数据无效，将返回一条清晰易读的错误信息，指出不正确数据的确切位置和内容。

*由于你已经在函数中将它声明为`Item` 类型，你还将获得对于所有属性及其类型的一切编辑器支持（代码补全等）。

*为你的模型生成 <ahref="https://json-schema.org"class="external-link"target="_blank">JSON模式</a> 定义，你还可以在其他任何对你的项目有意义的地方使用它们。

*这些模式将成为生成的 OpenAPI模式的一部分，并且被自动化文档 <abbrtitle="用户界面">UI</abbr> 所使用。

*以 JSON形式读取请求体；

* （在需要时）把请求体转换为对应的类型；

* 校验数据：

*数据无效时返回错误信息，指出错误数据的确切位置和内容。

*由于已经在函数中把请求体参数声明为`Item` 类型，还可以获得代码补全等对于所有属性及其类型的编辑器支持。

*为模型生成 <ahref="https://json-schema.org"class="external-link"target="_blank">JSONSchema</a> 定义，可以在项目中其他任何所需的位置使用；

*这些概图作为 OpenAPI概图的部件，用于自动文档 <abbrtitle="用户界面">UI</abbr>。

你所定义模型的 JSON模式将成为生成的 OpenAPI模式的一部分，并且在交互式 API文档中展示：

模型的 JSON概图是 OpenAPI生产的概图部件，可显示在 API交互文档中：

<imgsrc="https://fastapi.tiangolo.com/img/tutorial/body/image01.png">

<imgsrc="/img/tutorial/body/image01.png">

而且还将在每一个需要它们的*路径操作*的 API文档中使用：

而且，还会用于 API文档中使用了概图的*路径操作*：

<imgsrc="https://fastapi.tiangolo.com/img/tutorial/body/image02.png">

<imgsrc="/img/tutorial/body/image02.png">

在你的编辑器中，你会在函数内部的任意地方得到类型提示和代码补全（如果你接收的是一个`dict`而不是 Pydantic 模型，则不会发生这种情况）：

在编辑器中，函数内部均可使用类型提示、代码补全（如果接收的不是 Pydantic 模型，而是`dict`，就不会出现）：

<imgsrc="https://fastapi.tiangolo.com/img/tutorial/body/image03.png">

<imgsrc="/img/tutorial/body/image03.png">

你还会获得对不正确的类型操作的错误检查：

还支持对错误类型操作的错误检查：

<imgsrc="https://fastapi.tiangolo.com/img/tutorial/body/image04.png">

<imgsrc="/img/tutorial/body/image04.png">

这并非偶然，整个框架都是围绕该设计而构建。

这并非偶然，整个框架都是围绕这种操作精心设计的。

并且在进行任何实现之前，已经在设计阶段经过了全面测试，以确保它可以在所有的编辑器中生效。

并且，在着手实现 FastAPI 之前的设计阶段，我们就已经进行了全面测试，以确保 FastAPI 可以获得所有编辑器的支持。

Pydantic本身甚至也进行了一些更改以支持此功能。

甚至Pydantic也做出了改进，以支持此功能。

上面的截图取自 <ahref="https://code.visualstudio.com"class="external-link"target="_blank">Visual Studio Code</a>。

虽然上面的截图取自 <ahref="https://code.visualstudio.com"class="external-link"target="_blank">Visual Studio Code</a>。

但是在 <ahref="https://www.jetbrains.com/pycharm/"class="external-link"target="_blank">PyCharm</a>和绝大多数其他 Python编辑器中你也会获得同样的编辑器支持：

但 <ahref="https://www.jetbrains.com/pycharm/"class="external-link"target="_blank">PyCharm</a>和大多数 Python编辑器也支持同样的功能：

<imgsrc="https://fastapi.tiangolo.com/img/tutorial/body/image05.png">

<imgsrc="/img/tutorial/body/image05.png">

!!! tip "提示"

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

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

```Python hl_lines="19"

```Python hl_lines="21"

{!../../../docs_src/body/tutorial002.py!}

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

**FastAPI** 支持同时声明路径参数和请求体。

**FastAPI**将识别出与路径参数匹配的函数参数应**从路径中获取**，而声明为 Pydantic模型的函数参数应**从请求体中获取**。

**FastAPI**可以识别出与路径参数匹配的，**要从路径中获取**的函数参数，以及声明为 Pydantic模型的，**要从请求体中获取**的函数参数。

```Python hl_lines="15-16"

```Python hl_lines="17-18"

{!../../../docs_src/body/tutorial003.py!}

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

**FastAPI** 还支持同时声明**请求体**、**路径参数**和**查询参数**。

**FastAPI**会识别它们中的每一个，并从正确的位置获取数据。

**FastAPI**可以正确识别出这三种参数，并从正确的位置获取数据。

```Python hl_lines="16"

```Python hl_lines="18"

{!../../../docs_src/body/tutorial004.py!}

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

函数参数按如下规则进行识别：

-**路径**中声明了相同参数的参数，是路径参数

- 类型是（`int`、`float`、`str`、`bool` 等）**单类型**的参数，是**查询**参数

- 类型是**Pydantic 模型**的参数，是**请求体**

!!! note "笔记"

* 如果在**路径**中也声明了该参数，它将被用作路径参数。

* 如果参数的类型被声明为一个**Pydantic 模型**，它将被解释为**请求体**。

如果你不想使用 Pydantic 模型，你还可以使用**Body** 参数。请参阅文档[请求体 -多个参数：请求体中的单一值](body-multiple-params.md#singular-values-in-body){.internal-link target=_blank}。

即便不使用 Pydantic 模型，也可以使用**Body** 参数。请参阅[请求体 -多参数：请求体中的单值](body-multiple-params.md#singular-values-in-body){.internal-link target=\_blank}。