/// note | 注意

路径参数总是必需的，因为它必须是路径的一部分。即使你将其声明为 `None` 或设置了默认值，也不会产生任何影响，它依然始终是必需参数。

///

## 按需对参数排序 { #order-the-parameters-as-you-need }

/// tip | 提示

如果你使用 `Annotated`，这点可能不那么重要或必要。

///

假设你想要将查询参数 `q` 声明为必需的 `str`。

并且你不需要为该参数声明其他内容，所以实际上不需要用到 `Query`。

但是你仍然需要为路径参数 `item_id` 使用 `Path`。并且出于某些原因你不想使用 `Annotated`。

/// info

`Form` is a class that inherits directly from `Body`.

///

/// tip

To declare form bodies, you need to use `Form` explicitly, because without it the parameters would be interpreted as query parameters or body (JSON) parameters.

///

## About "Form Fields" { #about-form-fields }

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

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

`str` を継承することで、APIドキュメントは値が `string` 型でなければいけないことを知り、正確にレンダリングできるようになります。

そして、固定値のクラス属性を作ります。すると、その値が使用可能な値となります:

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

/// tip | 豆知識

"AlexNet"、"ResNet"そして"LeNet"は機械学習<dfn title="厳密には、Deep Learning のモデルアーキテクチャ">モデル</dfn>の名前です。

///

### *パスパラメータ*の宣言 { #declare-a-path-parameter }

デフォルト値は引き続き `None` なので、このパラメータは依然としてオプショナルです。

しかし、`Annotated` の中に `Query(max_length=50)` を入れることで、この値に **追加のバリデーション** をしたい、最大 50 文字にしたい、と FastAPI に伝えています。 😎

/// tip | 豆知識

ここでは **クエリパラメータ** なので `Query()` を使っています。後で `Path()`、`Body()`、`Header()`、`Cookie()` など、`Query()` と同じ引数を受け取れるものも見ていきます。

///

FastAPI は次を行います:

* 最大長が 50 文字であることを確かめるようデータを **検証** する

* `swagger_css_url`：Swagger UI 文件 HTML 用來取得「CSS」檔案的 URL。這是你的自訂 CDN 位址。

ReDoc 也類似...

{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[2:6,11:19,22:24,27:33] *}

/// tip

當你使用 OAuth2 時，`swagger_ui_redirect` 的路徑操作是個輔助端點。

如果你把 API 與 OAuth2 提供者整合，便能完成認證並帶著取得的憑證回到 API 文件，接著以真正的 OAuth2 驗證與之互動。

Swagger UI 會在背後幫你處理，不過它需要這個「redirect」輔助端點。

///

匯入 `Enum` 並建立一個同時繼承自 `str` 與 `Enum` 的子類別。

繼承自 `str` 之後，API 文件就能知道這些值的型別必須是 `string`，並能正確地呈現。

然後建立具有固定值的類別屬性，這些就是可用的有效值：

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

/// tip

如果你在想，「AlexNet」、「ResNet」和「LeNet」只是一些機器學習 <dfn title="嚴格來說是深度學習的模型架構">模型</dfn> 的名字。

///

### 宣告一個「路徑參數」 { #declare-a-path-parameter }

接著使用你建立的列舉類別（`ModelName`）作為型別註記，建立一個「路徑參數」：

You can set `"json_schema_extra"` with a `dict` containing any additional data you would like to show up in the generated JSON Schema, including `examples`.

/// tip

You could use the same technique to extend the JSON Schema and add your own custom extra info.

For example you could use it to add metadata for a frontend user interface, etc.

///

/// info

**TypeScript 클라이언트**의 경우 [Hey API](https://heyapi.dev/)는 TypeScript 생태계에 최적화된 경험을 제공하는 목적에 맞게 설계된 솔루션입니다.

더 많은 SDK 생성기는 [OpenAPI.Tools](https://openapi.tools/#sdk)에서 확인할 수 있습니다.

/// tip | 팁

FastAPI는 **OpenAPI 3.1** 사양을 자동으로 생성하므로, 사용하는 도구는 이 버전을 지원해야 합니다.

///

## FastAPI 스폰서의 SDK 생성기 { #sdk-generators-from-fastapi-sponsors }