以下のように設定できます:

{* ../../docs_src/metadata/tutorial001_py310.py hl[3:16, 19:32] *}

/// tip | 豆知識

`description` フィールドにはMarkdownを書けて、出力ではレンダリングされます。

///

この設定では、自動APIドキュメントは以下のようになります:

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

## ライセンス識別子 { #license-identifier }

```

</div>

ブラウザで [http://127.0.0.1:8000](http://127.0.0.1:8000) を開きます。

そこで、以下を設定できます。

* パスで使用される「Item ID」
* クエリパラメータとして使用される「Token」

/// tip | 豆知識

クエリ `token` は依存関係によって処理されることに注意してください。

///

これにより、WebSocketに接続してメッセージを送受信できます。

<img src="/img/tutorial/websockets/image05.png">

/// note

路徑參數一定是必填，因為它必須是路徑的一部分。即使你將其宣告為 `None` 或設定預設值，也不會有任何影響，它仍然是必填。

///

## 依需求調整參數順序 { #order-the-parameters-as-you-need }

/// tip

如果你使用 `Annotated`，這點大概沒那麼重要或必要。

///

假設你想把查詢參數 `q` 宣告為必要的 `str`。

而你不需要為該參數宣告其他內容，所以其實不需要用 `Query`。

但你仍需要為路徑參數 `item_id` 使用 `Path`，而且基於某些理由你不想用 `Annotated`。

```

...ve bunun döndürdüğü her şeyi, *path operation function* içinde `fixed_content_included` parametresine dependency değeri olarak geçirir:

{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[22] *}

/// tip | İpucu

Bunların tamamı biraz yapay görünebilir. Ayrıca bunun nasıl faydalı olduğu da henüz çok net olmayabilir.

Bu örnekler bilerek basit tutuldu; ama mekanizmanın nasıl çalıştığını gösteriyor.

checker(q="somequery")
```

…и передаст возвращённое значение как значение зависимости в параметр `fixed_content_included` нашей *функции-обработчику пути*:

{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[22] *}

/// tip | Совет

Все это может показаться притянутым за уши. И пока может быть не совсем понятно, чем это полезно.

Эти примеры намеренно простые, но они показывают, как всё устроено.

Write simple `assert` statements with the standard Python expressions that you need to check (again, standard `pytest`).

{* ../../docs_src/app_testing/tutorial001_py310.py hl[2,12,15:18] *}

/// tip

Notice that the testing functions are normal `def`, not `async def`.

And the calls to the client are also normal calls, not using `await`.

This allows you to use `pytest` directly without complications.

///

## 處理自訂請求本文編碼 { #handling-custom-request-body-encodings }

讓我們看看如何使用自訂的 `Request` 子類別來解壓縮 gzip 請求。

並透過 `APIRoute` 子類別來使用該自訂的請求類別。

### 建立自訂的 `GzipRequest` 類別 { #create-a-custom-gziprequest-class }

/// tip

這是一個示範用的簡化範例；如果你需要 Gzip 支援，可以直接使用提供的 [`GzipMiddleware`](../advanced/middleware.md#gzipmiddleware)。

///

首先，我們建立 `GzipRequest` 類別，它會覆寫 `Request.body()` 方法，當存在對應的標頭時解壓縮本文。

如果標頭中沒有 `gzip`，它就不會嘗試解壓縮本文。

///

## Parametreleri İhtiyacınıza Göre Sıralayın { #order-the-parameters-as-you-need }

/// tip | İpucu

`Annotated` kullanıyorsanız, bu muhtemelen o kadar önemli ya da gerekli değildir.

///

Diyelim ki query parametresi `q`'yu zorunlu bir `str` olarak tanımlamak istiyorsunuz.

由于每个 JSON 对象将以换行分隔，它们的内容中不能包含字面量换行符，但可以包含转义换行符（`\n`），这属于 JSON 标准的一部分。

不过通常你无需操心，这些都会自动完成，继续阅读即可。🤓

///

## 使用场景 { #use-cases }

你可以用它来从 AI LLM 服务、日志或遥测中流式传输数据，或其他可以用 JSON 项目来结构化的数据。

/// tip | 提示

如果你想流式传输二进制数据，例如视频或音频，请查看进阶指南：[流式传输数据](../advanced/stream-data.md)。

///

## 使用 FastAPI 流式传输 JSON Lines { #stream-json-lines-with-fastapi }

セマンティック バージョニングの規約に従って、`1.0.0` 未満のバージョンは破壊的な変更が加わる可能性があります。

FastAPI では「PATCH」バージョンの変更はバグ修正と非破壊的な変更に使う、という規約にも従っています。

/// tip | 豆知識

「PATCH」は最後の数字です。例えば、`0.2.3` では PATCH バージョンは `3` です。

///

従って、以下のようなバージョンの固定ができるはずです:

```txt
fastapi>=0.45.0,<0.46.0
```

破壊的な変更と新機能は「MINOR」バージョンで追加されます。

/// tip | 豆知識

「MINOR」は真ん中の数字です。例えば、`0.2.3` では MINOR バージョンは `2` です。

///