{* ../../docs_src/body/tutorial003_py310.py hl[15:16] *}


## Request body + path + query parameters { #request-body-path-query-parameters }

You can also declare **body**, **path** and **query** parameters, all at the same time.

**FastAPI** will recognize each of them and take the data from the correct place.

{* ../../docs_src/body/tutorial004_py310.py hl[16] *}

{* ../../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 | 情報

## List of models { #list-of-models }

The same way, you can declare responses of lists of objects.

For that, use the standard Python `list`:

{* ../../docs_src/extra_models/tutorial004_py310.py hl[18] *}

## Response with arbitrary `dict` { #response-with-arbitrary-dict }

你可以将其读取为一个请求头参数，并据此从客户端离开的地方恢复流：

{* ../../docs_src/server_sent_events/tutorial004_py310.py hl[25,27,31] *}

## 使用 POST 的 SSE { #sse-with-post }

SSE 适用于**任意 HTTP 方法**，不仅仅是 `GET`。

这对像 [MCP](https://modelcontextprotocol.io) 这样通过 `POST` 传输 SSE 的协议很有用：

{* ../../docs_src/server_sent_events/tutorial005_py310.py hl[14] *}

## 技术细节 { #technical-details }

FastAPI 开箱即用地实现了一些 SSE 的最佳实践。

"docs_src/security/tutorial004_an_py39.py" = ["B904"]
"docs_src/security/tutorial004_py310.py" = ["B904"]
"docs_src/security/tutorial004_py39.py" = ["B904"]
"docs_src/security/tutorial005_an_py310.py" = ["B904"]
"docs_src/security/tutorial005_an_py39.py" = ["B904"]
"docs_src/security/tutorial005_py310.py" = ["B904"]
"docs_src/security/tutorial005_py39.py" = ["B904"]
"docs_src/json_base64_bytes/tutorial001_py310.py" = ["UP012"]

{* ../../docs_src/path_params/tutorial005_py310.py hl[1,6:9] *}

/// tip | 팁

혹시 궁금하다면, "AlexNet", "ResNet", 그리고 "LeNet"은 그저 머신 러닝 <dfn title="기술적으로는 딥 러닝 모델 아키텍처">모델</dfn>들의 이름입니다.

///

### *경로 매개변수* 선언 { #declare-a-path-parameter }

생성한 열거형 클래스(`ModelName`)를 사용하는 타입 어노테이션으로 *경로 매개변수를* 만듭니다:

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

### 문서 확인 { #check-the-docs }

これをヘッダーパラメータとして受け取り、クライアントが離脱した位置からストリームを再開できます:

{* ../../docs_src/server_sent_events/tutorial004_py310.py hl[25,27,31] *}

## POST での SSE { #sse-with-post }

SSE は `GET` だけでなく、**任意の HTTP メソッド**で動作します。

これは、`POST` 上で SSE をストリーミングする [MCP](https://modelcontextprotocol.io) のようなプロトコルで有用です:

{* ../../docs_src/server_sent_events/tutorial005_py310.py hl[14] *}

## 技術詳細 { #technical-details }

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

## 從 docstring 提供進階描述 { #advanced-description-from-docstring }

你可以限制 OpenAPI 從*路徑操作函式*的 docstring 中使用的內容行數。

加上一個 `\f`（跳頁字元，form feed）會讓 FastAPI 在此處截斷用於 OpenAPI 的輸出。

這個字元不會出現在文件中，但其他工具（例如 Sphinx）仍可使用其後的內容。

{* ../../docs_src/path_operation_advanced_configuration/tutorial004_py310.py hl[17:27] *}

## 額外回應 { #additional-responses }

}
```

You can use that technique to reuse some predefined responses in your *path operations* and combine them with additional custom ones.

For example:

{* ../../docs_src/additional_responses/tutorial004_py310.py hl[11:15,24] *}

## More information about OpenAPI responses { #more-information-about-openapi-responses }

///

## 导入 Pydantic 的 `BaseModel` { #import-pydantics-basemodel }

从 `pydantic` 中导入 `BaseModel`：

{* ../../docs_src/body/tutorial001_py310.py hl[2] *}

## 创建数据模型 { #create-your-data-model }

把数据模型声明为继承 `BaseModel` 的类。

使用 Python 标准类型声明所有属性：

{* ../../docs_src/body/tutorial001_py310.py hl[5:9] *}

与声明查询参数一样，包含默认值的模型属性是可选的，否则就是必选的。把默认值设为 `None` 可使其变为可选。

例如，上述模型声明如下 JSON "object"（即 Python `dict`）：

```JSON