```Python hl_lines="1  3" title="app/routers/users.py"
{!../../../docs_src/bigger_applications/app/routers/users.py!}
```

### *Path operations* with `APIRouter`

And then you use it to declare your *path operations*.

Use it the same way you would use the `FastAPI` class:

```Python hl_lines="6  11  16" title="app/routers/users.py"

🌐 👥 💪 🍵 📨 🔘 `try`/`except` 🍫:

```Python hl_lines="13  15"
{!../../../docs_src/custom_request_and_route/tutorial002.py!}
```

🚥 ⚠ 📉, `Request` 👐 🔜 ↔, 👥 💪 ✍ & ⚒ ⚙️ 📨 💪 🕐❔ 🚚 ❌:

```Python hl_lines="16-18"
{!../../../docs_src/custom_request_and_route/tutorial002.py!}
```

## 🛃 `APIRoute` 🎓 📻

👆 💪 ⚒ `route_class` 🔢 `APIRouter`:

```Python hl_lines="26"

```Python hl_lines="21-23"
{!../../../docs_src/extending_openapi/tutorial001.py!}
```

### 缓存 OpenAPI 概图

把 `.openapi_schema` 属性当作**缓存**，存储生成的概图。

通过这种方式，**FastAPI** 应用不必在用户每次打开 API 文档时反复生成概图。

只需生成一次，下次请求时就可以使用缓存的概图。

```Python hl_lines="13-14  24-25"
{!../../../docs_src/extending_openapi/tutorial001.py!}
```

### 覆盖方法

用新函数替换 `.openapi()` 方法。

```Python hl_lines="28"

```jinja hl_lines="4"
{!../../../docs_src/templates/templates/item.html!}
```

Neste exemplo, ele seria vinculado a um arquivo CSS em `static/styles.css` com:

```CSS hl_lines="4"
{!../../../docs_src/templates/static/styles.css!}
```

You can set them as follows:

```Python hl_lines="3-16  19-32"
{!../../../docs_src/metadata/tutorial001.py!}
```

!!! tip
    You can write Markdown in the `description` field and it will be rendered in the output.

🥇, 🗄 `OAuth2PasswordRequestForm`, & ⚙️ ⚫️ 🔗 ⏮️ `Depends` *➡ 🛠️* `/token`:

=== "🐍 3️⃣.6️⃣ & 🔛"

    ```Python hl_lines="4  76"
    {!> ../../../docs_src/security/tutorial003.py!}
    ```

=== "🐍 3️⃣.1️⃣0️⃣ & 🔛"

    ```Python hl_lines="2  74"
    {!> ../../../docs_src/security/tutorial003_py310.py!}
    ```

`OAuth2PasswordRequestForm` 🎓 🔗 👈 📣 📨 💪 ⏮️:

*  `username`.

```Python
item: Item = Body(..., embed=True)
```

以下において:

```Python hl_lines="17"
{!../../../docs_src/body_multiple_params/tutorial005.py!}
```

この場合、**FastAPI** は以下のようなボディを期待します:

```JSON hl_lines="2"
{
    "item": {
        "name": "Foo",
        "description": "The pretender",
        "price": 42.0,
        "tax": 3.2
    }

同様に、デフォルト値を `None` とすることで、オプショナルなクエリパラメータを宣言できます:

```Python hl_lines="9"
{!../../../docs_src/query_params/tutorial002.py!}
```

この場合、関数パラメータ `q` はオプショナルとなり、デフォルトでは `None` になります。

!!! check "確認"
    パスパラメータ `item_id` はパスパラメータであり、`q` はそれとは違ってクエリパラメータであると判別できるほど**FastAPI** が賢いということにも注意してください。

## クエリパラメータの型変換

`bool` 型も宣言できます。これは以下の様に変換されます:

```Python hl_lines="9"
{!../../../docs_src/query_params/tutorial003.py!}
```

Vamos iniciar com um exemplo e ver isso detalhadamente.

Nós criamos uma função assíncrona chamada `lifespan()` com `yield` como este:

```Python hl_lines="16  19"
{!../../../docs_src/events/tutorial003.py!}
```

每个响应字典都可以有一个关键模型，其中包含一个 `Pydantic` 模型，就像 `response_model` 一样。

**FastAPI**将采用该模型，生成其`JSON Schema`并将其包含在`OpenAPI`中的正确位置。

例如，要声明另一个具有状态码 `404` 和`Pydantic`模型 `Message` 的响应，可以写：
```Python hl_lines="18  22"
{!../../../docs_src/additional_responses/tutorial001.py!}
```


!!! Note
	请记住，您必须直接返回 `JSONResponse` 。

!!! Info
	`model` 密钥不是OpenAPI的一部分。