ボディ - フィールド¶

QueryやPath、Bodyを使って path operation関数 のパラメータに追加のバリデーションやメタデータを宣言するのと同じように、PydanticのFieldを使ってPydanticモデルの内部でバリデーションやメタデータを宣言することができます。

`Field`のインポート¶

まず、以下のようにインポートします:


from typing import Union

from fastapi import Body, FastAPI
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Union[str, None] = Field(
        default=None, title="The description of the item", max_length=300
    )
    price: float = Field(gt=0, description="The price must be greater than zero")
    tax: Union[float, None] = None


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item = Body(embed=True)):
    results = {"item_id": item_id, "item": item}
    return results

注意

Fieldは他の全てのもの（Query、Path、Bodyなど）とは違い、fastapiからではなく、pydanticから直接インポートされていることに注意してください。

モデルの属性の宣言¶

以下のようにFieldをモデルの属性として使用することができます:


from typing import Union

from fastapi import Body, FastAPI
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Union[str, None] = Field(
        default=None, title="The description of the item", max_length=300
    )
    price: float = Field(gt=0, description="The price must be greater than zero")
    tax: Union[float, None] = None


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item = Body(embed=True)):
    results = {"item_id": item_id, "item": item}
    return results

FieldはQueryやPath、Bodyと同じように動作し、全く同様のパラメータなどを持ちます。

技術詳細

実際には次に見るQueryやPathなどは、共通のParamクラスのサブクラスのオブジェクトを作成しますが、それ自体はPydanticのFieldInfoクラスのサブクラスです。

また、PydanticのFieldはFieldInfoのインスタンスも返します。

BodyはFieldInfoのサブクラスのオブジェクトを直接返すこともできます。そして、他にもBodyクラスのサブクラスであるものがあります。

fastapiからQueryやPathなどをインポートする場合、これらは実際には特殊なクラスを返す関数であることに注意してください。

豆知識

型、デフォルト値、Fieldを持つ各モデルの属性が、PathやQuery、Bodyの代わりにFieldを持つ、path operation 関数のパラメータと同じ構造になっていることに注目してください。

追加情報の追加¶

追加情報はFieldやQuery、Bodyなどで宣言することができます。そしてそれは生成されたJSONスキーマに含まれます。

後に例を用いて宣言を学ぶ際に、追加情報を句悪方法を学べます。

まとめ¶

PydanticのFieldを使用して、モデルの属性に追加のバリデーションやメタデータを宣言することができます。

追加のキーワード引数を使用して、追加のJSONスキーマのメタデータを渡すこともできます。