## Como Parece

Vamos primeiro usar o código e ver como funciona, e depois voltaremos para entender o que está acontecendo.

## Crie um `main.py`
Copie o exemplo em um arquivo `main.py`:

```Python
{!../../docs_src/security/tutorial001.py!}
```

## Execute-o

/// info | "informação"



///

//// tab | Python 3.10+

```Python hl_lines="4  21"
{!> ../../docs_src/encoder/tutorial001_py310.py!}
```

////

//// tab | Python 3.6+

```Python hl_lines="5  22"
{!> ../../docs_src/encoder/tutorial001.py!}
```

////

В данном примере она преобразует Pydantic модель в `dict`, а `datetime` - в `str`.

## `Header` 임포트

먼저 `Header`를 임포트합니다:

```Python hl_lines="3"
{!../../docs_src/header_params/tutorial001.py!}
```

## `Header` 매개변수 선언

`Path`, `Query` 그리고 `Cookie`를 사용한 동일한 구조를 이용하여 헤더 매개변수를 선언합니다.

첫 번째 값은 기본값이며, 추가 검증이나 어노테이션 매개변수 모두 전달할 수 있습니다:

```Python hl_lines="9"
{!../../docs_src/header_params/tutorial001.py!}
```

/// note | "기술 세부사항"

{!../../docs_src/metadata/tutorial001.py!}
```

/// tip

您可以在 `description` 字段中编写 Markdown，它将在输出中呈现。

///

通过这样设置，自动 API 文档看起来会像：

<img src="/img/tutorial/metadata/image01.png">

## 标签元数据

### 创建标签元数据

让我们在带有标签的示例中为 `users` 和 `items` 试一下。

创建标签元数据并把它传递给 `openapi_tags` 参数：

```Python hl_lines="3-16  18"
{!../../docs_src/metadata/tutorial004.py!}
```

RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt

# (1)!
COPY ./main.py /code/

# (2)!
CMD ["fastapi", "run", "main.py", "--port", "80"]
```

1. Copy the `main.py` file to the `/code` directory directly (without any `./app` directory).

2. Use `fastapi run` to serve your application in the single file `main.py`.

让我们从一个简单的 FastAPI 应用开始：

//// tab | Python 3.9+

```Python hl_lines="7-9  12-13  16-17  21"
{!> ../../docs_src/generate_clients/tutorial001_py39.py!}
```

////

//// tab | Python 3.8+

```Python hl_lines="9-11  14-15  18  19  23"
{!> ../../docs_src/generate_clients/tutorial001.py!}
```

////

请注意，*路径操作* 定义了他们所用于请求数据和回应数据的模型，所使用的模型是`Item` 和 `ResponseMessage`。

### API 文档

## 🗄 `Field`

🥇, 👆 ✔️ 🗄 ⚫️:

//// tab | 🐍 3️⃣.6️⃣ & 🔛

```Python hl_lines="4"
{!> ../../docs_src/body_fields/tutorial001.py!}
```

////

//// tab | 🐍 3️⃣.1️⃣0️⃣ & 🔛

```Python hl_lines="2"
{!> ../../docs_src/body_fields/tutorial001_py310.py!}
```

////

/// warning

👀 👈 `Field` 🗄 🔗 ⚪️➡️ `pydantic`, 🚫 ⚪️➡️ `fastapi` 🌐 🎂 (`Query`, `Path`, `Body`, ♒️).

///

```Python hl_lines="4"
{!../../docs_src/body_fields/tutorial001.py!}
```

/// warning | "Aviso"

Note que `Field` é importado diretamente do `pydantic`, não do `fastapi` como todo o resto (`Query`, `Path`, `Body`, etc).

///

## Declare atributos do modelo

Você pode então utilizar `Field` com atributos do modelo:

```Python hl_lines="11-14"
{!../../docs_src/body_fields/tutorial001.py!}
```

///

## 🗄 `Form`

🗄 `Form` ⚪️➡️ `fastapi`:

```Python hl_lines="1"
{!../../docs_src/request_forms/tutorial001.py!}
```

## 🔬 `Form` 🔢

✍ 📨 🔢 🎏 🌌 👆 🔜 `Body` ⚖️ `Query`:

```Python hl_lines="7"
{!../../docs_src/request_forms/tutorial001.py!}
```

🖼, 1️⃣ 🌌 Oauth2️⃣ 🔧 💪 ⚙️ (🤙 "🔐 💧") ⚫️ ✔ 📨 `username` & `password` 📨 🏑.

对此你可以使用`jsonable_encoder`。

它接收一个对象，比如Pydantic模型，并会返回一个JSON兼容的版本：

//// tab | Python 3.10+

```Python hl_lines="4  21"
{!> ../../docs_src/encoder/tutorial001_py310.py!}
```

////

//// tab | Python 3.8+

```Python hl_lines="5  22"
{!> ../../docs_src/encoder/tutorial001.py!}
```

////

在这个例子中，它将Pydantic模型转换为`dict`，并将`datetime`转换为`str`。