* 100% test coverage.
* 100% type annotated codebase.

## Pydantic 기능 { #pydantic-features }

**FastAPI**는 [**Pydantic**](https://docs.pydantic.dev/)과 완벽하게 호환되며(또한 이를 기반으로 합니다). 따라서 추가로 가지고 있는 Pydantic 코드도 모두 동작합니다.

데이터베이스를 위한 <abbr title="Object-Relational Mapper - 객체-관계 매퍼">ORM</abbr>, <abbr title="Object-Document Mapper - 객체-문서 매퍼">ODM</abbr>과 같은, Pydantic을 기반으로 하는 외부 라이브러리도 포함합니다.

This would allow you to **re-use the model** in **multiple places** and also to declare validations and metadata for all the parameters at once. 😎

/// note

This is supported since FastAPI version `0.115.0`. 🤓

///

## Header Parameters with a Pydantic Model { #header-parameters-with-a-pydantic-model }

from fastapi.types import IncEx, ModelNameMap, UnionType
from pydantic import BaseModel, ConfigDict, Field, TypeAdapter, create_model
from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError
from pydantic import PydanticUndefinedAnnotation as PydanticUndefinedAnnotation
from pydantic import ValidationError as ValidationError

这意味着，在 Python 中从环境变量读取的任何值都是 `str` 类型，任何到不同类型的转换或任何验证都必须在代码中完成。

## Pydantic 的 `Settings` { #pydantic-settings }

幸运的是，Pydantic 提供了一个很好的工具来处理来自环境变量的这些设置：[Pydantic：Settings 管理](https://docs.pydantic.dev/latest/concepts/pydantic_settings/)。

### 安装 `pydantic-settings` { #install-pydantic-settings }

首先，确保你创建并激活了[虚拟环境](../virtual-environments.md)，然后安装 `pydantic-settings` 包：

<div class="termy">

```console

你可以在 FastAPI 中使用 **Pydantic 模型**声明**表单字段**。

/// info | 信息

要使用表单，首先安装 [`python-multipart`](https://github.com/Kludex/python-multipart)。

确保你创建一个[虚拟环境](../virtual-environments.md)，激活它，然后再安装，例如：

```console
$ pip install python-multipart
```

///

/// note | 注意

自 FastAPI 版本 `0.113.0` 起支持此功能。🤓

///

## 表单的 Pydantic 模型 { #pydantic-models-for-forms }

        ```
    validations:
      required: true
  - type: input
    id: pydantic-version
    attributes:
      label: Pydantic Version
      description: |
        What Pydantic version are you using?

        You can find the Pydantic version with:

        ```bash
        python -c "import pydantic; print(pydantic.version.VERSION)"
        ```
    validations:
      required: true
  - type: input

# Cookie 參數模型 { #cookie-parameter-models }

如果你有一組彼此相關的「**Cookie**」，你可以建立一個「**Pydantic 模型**」來宣告它們。🍪

這樣你就能在**多處**重複使用該模型，並且能一次性為所有參數宣告**驗證**與**中繼資料**。😎

/// note | 注意

自 FastAPI 版本 `0.115.0` 起支援。🤓

///

/// tip

同樣的技巧也適用於 `Query`、`Cookie` 與 `Header`。😎

///

## 以 Pydantic 模型宣告 Cookie { #cookies-with-a-pydantic-model }

在 **Pydantic 模型**中宣告所需的 **Cookie** 參數，接著將參數宣告為 `Cookie`：

## Do not use Pydantic RootModels

Do not use Pydantic `RootModel`, instead use regular type annotations with `Annotated` and Pydantic validation utilities.

For example, for a list with validations you could do:

```python
from typing import Annotated

from fastapi import Body, FastAPI
from pydantic import Field

app = FastAPI()


@app.post("/items/")

* **Session and Cookie** support.
* 100% test coverage.
* 100% type annotated codebase.

## Pydantic features { #pydantic-features }

**FastAPI** is fully compatible with (and based on) [**Pydantic**](https://docs.pydantic.dev/). So, any additional Pydantic code you have, will also work.

# Body - 欄位 { #body-fields }

就像你可以在「路徑操作函式 (path operation function)」的參數中用 `Query`、`Path` 和 `Body` 宣告額外的驗證與中繼資料一樣，你也可以在 Pydantic 模型中使用 Pydantic 的 `Field` 來宣告驗證與中繼資料。

## 匯入 `Field` { #import-field }

首先，你需要匯入它：

{* ../../docs_src/body_fields/tutorial001_an_py310.py hl[4] *}


/// warning

請注意，`Field` 是直接從 `pydantic` 匯入的，不像其他（如 `Query`、`Path`、`Body` 等）是從 `fastapi` 匯入。

///

## 宣告模型屬性 { #declare-model-attributes }