Alejandra <******@****.***> 1710416405 +0100

모든 것이 단독으로 중첩됩니다.

### 서브모델 정의

예를 들어, `Image` 모델을 선언할 수 있습니다:

{* ../../docs_src/body_nested_models/tutorial004.py hl[9:11] *}

### 서브모듈을 타입으로 사용

그리고 어트리뷰트의 타입으로 사용할 수 있습니다:

{* ../../docs_src/body_nested_models/tutorial004.py hl[20] *}

이는 **FastAPI**가 다음과 유사한 본문을 기대한다는 것을 의미합니다:

```JSON
{
    "name": "Foo",
    "description": "The pretender",
    "price": 42.0,

### Створення метаданих для тегів

Спробуймо це на прикладі з тегами для `users` та `items`.

Створіть метадані для своїх тегів і передайте їх у параметр  `openapi_tags`:

{* ../../docs_src/metadata/tutorial004.py hl[3:16,18] *}

Зверніть увагу, що в описах можна використовувати Markdown, наприклад, "login" буде показано жирним шрифтом (**login**), а "fancy" буде показано курсивом (_fancy_).

/// tip | Порада

대신 평문 비밀번호로 입력 모델을 만들고 해당 비밀번호 없이 출력 모델을 만들 수 있습니다:

{* ../../docs_src/response_model/tutorial003.py hl[9,11,16] *}

여기서 *경로 작동 함수*가 비밀번호를 포함하는 동일한 입력 사용자를 반환할지라도:

{* ../../docs_src/response_model/tutorial003.py hl[24] *}

...`response_model`을 `UserOut` 모델로 선언했기 때문에 비밀번호를 포함하지 않습니다:

{* ../../docs_src/response_model/tutorial003.py hl[22] *}

따라서 **FastAPI**는 출력 모델에서 선언하지 않은 모든 데이터를 (Pydantic을 사용하여) 필터링합니다.

## 문서에서 보기

你可以按如下方式设置它们：

{* ../../docs_src/metadata/tutorial001.py hl[4:6] *}

/// tip

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

///

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

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

## 标签元数据

### 创建标签元数据

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

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

{* ../../docs_src/metadata/tutorial004.py hl[3:16,18] *}

{* ../../docs_src/metadata/tutorial004.py hl[3:16,18] *}

説明文 (description) の中で Markdown を使用できることに注意してください。たとえば、「login」は太字 (**login**) で表示され、「fancy」は斜体 (_fancy_) で表示されます。

/// tip | 豆知識

使用するすべてのタグにメタデータを追加する必要はありません。

///

### 自作タグの使用

`tags` パラメーターを使用して、それぞれの *path operations* (および `APIRouter`) を異なるタグに割り当てます:

{* ../../docs_src/metadata/tutorial004.py hl[21,26] *}

/// info | 情報

一般情况下可能不会需要在代码中直接使用响应头。

但对于某些高级应用场景，还是需要添加自定义响应头：

{* ../../docs_src/handling_errors/tutorial002.py hl[14] *}

## 安装自定义异常处理器

添加自定义处理器，要使用 [Starlette 的异常工具](https://www.starlette.dev/exceptions/)。

假设要触发的自定义异常叫作 `UnicornException`。

且需要 FastAPI 实现全局处理该异常。

此时，可以用 `@app.exception_handler()` 添加自定义异常控制器：

{* ../../docs_src/handling_errors/tutorial003.py hl[5:7,13:18,24] *}

请求 `/unicorns/yolo` 时，路径操作会触发 `UnicornException`。

{* ../../docs_src/path_operation_advanced_configuration/tutorial003.py hl[6] *}

## docstringによる説明の高度な設定

*path operation関数* のdocstringからOpenAPIに使用する行を制限することができます。

`\f` (「書式送り (Form Feed)」のエスケープ文字) を付与することで、**FastAPI** はOpenAPIに使用される出力をその箇所までに制限します。

ドキュメントには表示されませんが、他のツール (例えばSphinx) では残りの部分を利用できるでしょう。

Обробник помилок отримує `Request` і саму помилку.

{* ../../docs_src/handling_errors/tutorial004.py hl[2,14:16] *}

Тепер, якщо Ви перейдете за посиланням `/items/foo`, замість того, щоб отримати стандартну JSON-помилку:

```JSON
{
    "detail": [
        {
            "loc": [

///

{* ../../docs_src/custom_response/tutorial001.py hl[2,7] *}

/// tip | 小贴士

`ORJSONResponse` 可能是一个更快的选择。

///

### `RedirectResponse`

返回 HTTP 重定向。默认情况下使用 307 状态代码（临时重定向）。

{* ../../docs_src/custom_response/tutorial006.py hl[2,9] *}

### `StreamingResponse`

采用异步生成器或普通生成器/迭代器，然后流式传输响应主体。

{* ../../docs_src/custom_response/tutorial007.py hl[2,14] *}