{* ../../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/response_directly/tutorial002_py310.py hl[1,18] *}

### `HTMLResponse` { #htmlresponse }

텍스트 또는 바이트를 받아 HTML 응답을 반환합니다. 위에서 설명한 내용과 같습니다.

### `PlainTextResponse` { #plaintextresponse }

텍스트 또는 바이트를 받아 일반 텍스트 응답을 반환합니다.

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

### `JSONResponse` { #jsonresponse }

{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *}

### `HTMLResponse` { #htmlresponse }

Usa algum texto ou sequência de bytes e retorna uma resposta HTML. Como você leu acima.

### `PlainTextResponse` { #plaintextresponse }

Usa algum texto ou sequência de bytes para retornar uma resposta de texto não formatado.

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

## Use `HTTPException` { #use-httpexception }

To return HTTP responses with errors to the client you use `HTTPException`.

### Import `HTTPException` { #import-httpexception }

{* ../../docs_src/handling_errors/tutorial001_py310.py hl[1] *}

### Raise an `HTTPException` in your code { #raise-an-httpexception-in-your-code }

`HTTPException` is a normal Python exception with additional data relevant for APIs.

从 `fastapi.sse` 导入 `EventSourceResponse`：

{* ../../docs_src/server_sent_events/tutorial001_py310.py ln[1:25] hl[4,22] *}

每个被 yield 的项会被编码为 JSON，并放入 SSE 事件的 `data:` 字段发送。

如果你将返回类型声明为 `AsyncIterable[Item]`，FastAPI 将使用它通过 Pydantic对数据进行**校验**、**文档化**和**序列化**。

{* ../../docs_src/server_sent_events/tutorial001_py310.py ln[1:25] hl[10:12,23] *}

/// tip | 提示

由于 Pydantic 会在**Rust** 端序列化它，相比未声明返回类型，你将获得更高的**性能**。

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

Тут, хоча наша *функція операції шляху* повертає того самого вхідного користувача, який містить пароль:

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

...ми оголосили `response_model` як нашу модель `UserOut`, яка не містить пароля:

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

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

Здесь, хотя *функция-обработчик пути* возвращает тот же входной объект пользователя, содержащий пароль:

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

...мы объявили `response_model` как модель `UserOut`, в которой нет пароля:

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

## `HTTPException` 사용하기 { #use-httpexception }

클라이언트에 오류가 포함된 HTTP 응답을 반환하려면 `HTTPException`을 사용합니다.

### `HTTPException` 가져오기 { #import-httpexception }

{* ../../docs_src/handling_errors/tutorial001_py310.py hl[1] *}

### 코드에서 `HTTPException` 발생시키기 { #raise-an-httpexception-in-your-code }

`HTTPException`은 API와 관련된 추가 데이터를 가진 일반적인 Python 예외입니다.

Python 예외이므로 `return` 하는 것이 아니라 `raise` 합니다.

{* ../../docs_src/path_params/tutorial005_py310.py hl[17] *}

#### Получение *значения перечисления* { #get-the-enumeration-value }

Можно получить фактическое значение (в данном случае - `str`) с помощью `model_name.value` или в общем случае `your_enum_member.value`:

{* ../../docs_src/path_params/tutorial005_py310.py hl[20] *}

/// tip | Подсказка

`EventSourceResponse`는 `fastapi.sse`에서 임포트합니다:

{* ../../docs_src/server_sent_events/tutorial001_py310.py ln[1:25] hl[4,22] *}

각 `yield`된 항목은 JSON으로 인코딩되어 SSE 이벤트의 `data:` 필드로 전송됩니다.

반환 타입을 `AsyncIterable[Item]`으로 선언하면 FastAPI가 이를 사용해 데이터를 Pydantic으로 **검증**, **문서화**, **직렬화**합니다.

{* ../../docs_src/server_sent_events/tutorial001_py310.py ln[1:25] hl[10:12,23] *}

/// tip | 팁