mirror of
https://github.com/fastapi/fastapi.git
synced 2026-02-06 12:21:13 -05:00
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Yurii Motov <yurii.motov.monte@gmail.com> Co-authored-by: Motov Yurii <109919500+YuriiMotov@users.noreply.github.com> Co-authored-by: Maruo.S <raspi-maru2004@outlook.jp>
62 lines
3.0 KiB
Markdown
62 lines
3.0 KiB
Markdown
# ボディ - フィールド { #body-fields }
|
|
|
|
`Query`や`Path`、`Body`を使って *path operation関数* のパラメータに追加のバリデーションやメタデータを宣言するのと同じように、Pydanticの`Field`を使ってPydanticモデルの内部でバリデーションやメタデータを宣言することができます。
|
|
|
|
## `Field`のインポート { #import-field }
|
|
|
|
まず、以下のようにインポートします:
|
|
|
|
{* ../../docs_src/body_fields/tutorial001_an_py310.py hl[4] *}
|
|
|
|
|
|
/// warning | 注意
|
|
|
|
`Field`は他の全てのもの(`Query`、`Path`、`Body`など)とは違い、`fastapi`からではなく、`pydantic`から直接インポートされていることに注意してください。
|
|
|
|
///
|
|
|
|
## モデルの属性の宣言 { #declare-model-attributes }
|
|
|
|
以下のように`Field`をモデルの属性として使用することができます:
|
|
|
|
{* ../../docs_src/body_fields/tutorial001_an_py310.py hl[11:14] *}
|
|
|
|
`Field`は`Query`や`Path`、`Body`と同じように動作し、全く同様のパラメータなどを持ちます。
|
|
|
|
/// note | 技術詳細
|
|
|
|
実際には次に見る`Query`や`Path`などは、共通の`Param`クラスのサブクラスのオブジェクトを作成しますが、それ自体はPydanticの`FieldInfo`クラスのサブクラスです。
|
|
|
|
また、Pydanticの`Field`は`FieldInfo`のインスタンスも返します。
|
|
|
|
`Body`は`FieldInfo`のサブクラスのオブジェクトを直接返すこともできます。そして、他にも`Body`クラスのサブクラスであるものがあります。
|
|
|
|
`fastapi`から`Query`や`Path`などをインポートする場合、これらは実際には特殊なクラスを返す関数であることに注意してください。
|
|
|
|
///
|
|
|
|
/// tip | 豆知識
|
|
|
|
型、デフォルト値、`Field`を持つ各モデルの属性が、`Path`や`Query`、`Body`の代わりに`Field`を持つ、*path operation 関数の*パラメータと同じ構造になっていることに注目してください。
|
|
|
|
///
|
|
|
|
## 追加情報の追加 { #add-extra-information }
|
|
|
|
追加情報は`Field`や`Query`、`Body`などで宣言することができます。そしてそれは生成されたJSONスキーマに含まれます。
|
|
|
|
後に例を用いて宣言を学ぶ際に、追加情報を追加する方法を学べます。
|
|
|
|
/// warning | 注意
|
|
|
|
`Field`に渡された追加のキーは、結果として生成されるアプリケーションのOpenAPIスキーマにも含まれます。
|
|
これらのキーは必ずしもOpenAPI仕様の一部であるとは限らないため、例えば[OpenAPI validator](https://validator.swagger.io/)などの一部のOpenAPIツールは、生成されたスキーマでは動作しない場合があります。
|
|
|
|
///
|
|
|
|
## まとめ { #recap }
|
|
|
|
Pydanticの`Field`を使用して、モデルの属性に追加のバリデーションやメタデータを宣言することができます。
|
|
|
|
追加のキーワード引数を使用して、追加のJSONスキーマのメタデータを渡すこともできます。
|