Sebastián Ramírez <******@****.***> 1641564691 +0100

Sebastián Ramírez <******@****.***> 1641564691 +0100

{* ../../docs_src/path_operation_configuration/tutorial004_py310.py hl[17:25] *}

It will be used in the interactive docs:

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

## Response description { #response-description }

You can specify the response description with the parameter `response_description`:

{* ../../docs_src/path_operation_configuration/tutorial005_py310.py hl[18] *}

/// info

You could do that with `openapi_extra`:

{* ../../docs_src/path_operation_advanced_configuration/tutorial006_py310.py hl[19:36, 39:40] *}

{* ../../docs_src/path_operation_configuration/tutorial004_py310.py hl[17:25] *}

這會用於互動式文件：

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

## 回應描述 { #response-description }

你可以用參數 `response_description` 指定回應的描述：

{* ../../docs_src/path_operation_configuration/tutorial005_py310.py hl[18] *}

/// info | 資訊

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

### *경로 처리 함수* 이름을 operationId로 사용하기 { #using-the-path-operation-function-name-as-the-operationid }

API의 함수 이름을 `operationId`로 사용하고 싶다면, 모든 API를 순회하면서 `APIRoute.name`을 사용해 각 *경로 처리*의 `operation_id`를 덮어쓸 수 있습니다.

모든 *경로 처리*를 추가한 뒤에 수행해야 합니다.

{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py310.py hl[2, 12:21, 24] *}

/// tip | 팁

    "needy": "sooooneedy"
}
```

And of course, you can define some parameters as required, some as having a default value, and some entirely optional:

{* ../../docs_src/query_params/tutorial006_py310.py hl[8] *}

In this case, there are 3 query parameters:

* `needy`, a required `str`.
* `skip`, an `int` with a default value of `0`.
* `limit`, an optional `int`.

/// tip

{* ../../docs_src/body_nested_models/tutorial005_py310.py hl[2,8] *}

The string will be checked to be a valid URL, and documented in JSON Schema / OpenAPI as such.

## Attributes with lists of submodels { #attributes-with-lists-of-submodels }

You can also use Pydantic models as subtypes of `list`, `set`, etc.:

{* ../../docs_src/body_nested_models/tutorial006_py310.py hl[18] *}

{* ../../docs_src/body_nested_models/tutorial005_py310.py hl[2,8] *}

이 문자열은 유효한 URL인지 검사되며, JSON Schema / OpenAPI에도 그에 맞게 문서화됩니다.

## 서브모델 리스트를 갖는 어트리뷰트 { #attributes-with-lists-of-submodels }

`list`, `set` 등의 서브타입으로 Pydantic 모델을 사용할 수도 있습니다:

{* ../../docs_src/body_nested_models/tutorial006_py310.py hl[18] *}

아래와 같은 JSON 본문을 예상(변환, 검증, 문서화 등)합니다:

```JSON hl_lines="11"

{* ../../docs_src/body_nested_models/tutorial005_py310.py hl[2,8] *}

該字串會被檢查是否為有效的 URL，並在 JSON Schema / OpenAPI 中相應註記。

## 具有子模型列表的屬性 { #attributes-with-lists-of-submodels }

你也可以將 Pydantic 模型作為 `list`、`set` 等的子型別使用：

{* ../../docs_src/body_nested_models/tutorial006_py310.py hl[18] *}

這會期望（並進行轉換、驗證、文件化等）如下的 JSON 本文：

```JSON hl_lines="11"
{