{* ../../docs_src/python_types/tutorial003.py hl[1] *}


Editör değişkenlerin tiplerini bildiğinden, yalnızca otomatik tamamlama değil, hata kontrolleri de sağlar:

<img src="/img/python-types/image04.png">

Artık `age` değişkenini `str(age)` olarak kullanmanız gerektiğini biliyorsunuz:

{* ../../docs_src/python_types/tutorial004.py hl[2] *}


## Tip bildirme

{* ../../docs_src/path_operation_configuration/tutorial004.py hl[19:27] *}

下图为 Markdown 文本在 API 文档中的显示效果：

<img src="/img/tutorial/path-operation-configuration/image02.png">

## 响应描述

`response_description` 参数用于定义响应的描述说明：

{* ../../docs_src/path_operation_configuration/tutorial005.py hl[21] *}

/// info | 说明

注意，`response_description` 只用于描述响应，`description` 一般则用于描述*路径操作*。

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

## docstring 的高级描述

你可以限制 *路径操作函数* 的 `docstring` 中用于 OpenAPI 的行数。

添加一个 `\f` （一个「换页」的转义字符）可以使 **FastAPI** 在那一位置截断用于 OpenAPI 的输出。

剩余部分不会出现在文档中，但是其他工具（比如 Sphinx）可以使用剩余部分。

import pytest
from dirty_equals import IsList
from fastapi.testclient import TestClient

from ...utils import needs_py310

DESCRIPTIONS = {
    "tutorial003": "Create an item with all the information, name, description, price, tax and a set of unique tags",
    "tutorial004": dedent("""
        Create an item with all the information:

        - **name**: each item must have a name
        - **description**: a long description

매개변수들은 이름으로 감지됩니다:

{* ../../docs_src/query_params/tutorial004.py hl[8,10] *}

## 필수 쿼리 매개변수

경로가 아닌 매개변수에 대한 기본값을 선언할 때(지금은 쿼리 매개변수만 보았습니다), 해당 매개변수는 필수적(Required)이지 않았습니다.

특정값을 추가하지 않고 선택적으로 만들기 위해선 기본값을 `None`으로 설정하면 됩니다.

그러나 쿼리 매개변수를 필수로 만들려면 단순히 기본값을 선언하지 않으면 됩니다:

{* ../../docs_src/query_params/tutorial005.py hl[6:7] *}

여기 쿼리 매개변수 `needy`는 `str`형인 필수 쿼리 매개변수입니다.

{* ../../docs_src/path_operation_configuration/tutorial004.py hl[19:27] *}

이는 대화형 문서에서 사용됩니다:

<img src="/img/tutorial/path-operation-configuration/image02.png">

## 응답 기술

`response_description` 매개변수로 응답에 관한 설명을 명시할 수 있습니다:

{* ../../docs_src/path_operation_configuration/tutorial005.py hl[21] *}

/// info | 정보

すべては、任意のネストにされています。

### サブモデルの定義

例えば、`Image`モデルを定義することができます:

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

### サブモデルを型として使用

そして、それを属性の型として使用することができます:

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

これは **FastAPI** が以下のようなボディを期待することを意味します:

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

///

## 返回与输入相同的数据

现在我们声明一个 `UserIn` 模型，它将包含一个明文密码属性。

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

我们正在使用此模型声明输入数据，并使用同一模型声明输出数据：

{* ../../docs_src/response_model/tutorial002.py hl[17:18] *}

现在，每当浏览器使用一个密码创建用户时，API 都会在响应中返回相同的密码。

在这个案例中，这可能不算是问题，因为用户自己正在发送密码。

但是，如果我们在其他的*路径操作*中使用相同的模型，则可能会将用户的密码发送给每个客户端。

/// danger

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

설명 안에 마크다운을 사용할 수 있습니다. 예를 들어 "login"은 굵게(**login**) 표시되고, "fancy"는 기울임꼴(_fancy_)로 표시됩니다.

/// tip

사용 중인 모든 태그에 메타데이터를 추가할 필요는 없습니다.

///

### 태그 사용

`tags` 매개변수를 *경로 작동* 및 `APIRouter`와 함께 사용하여 태그에 할당할 수 있습니다:

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

/// info

Pour cela, importez d'abord `Query` depuis `fastapi` :

{* ../../docs_src/query_params_str_validations/tutorial002.py hl[3] *}

## Utiliser `Query` comme valeur par défaut

Construisez ensuite la valeur par défaut de votre paramètre avec `Query`, en choisissant 50 comme `max_length` :

{* ../../docs_src/query_params_str_validations/tutorial002.py hl[9] *}