データクラスの使用¶
FastAPIは**Pydantic**の上に構築されており、リクエストとレスポンスを宣言するためにPydanticモデルを使用する方法を紹介してきました。
しかし、FastAPIはdataclasses も同様に使用できます。
from dataclasses import dataclass
from typing import Union
from fastapi import FastAPI
@dataclass
class Item:
name: str
price: float
description: Union[str, None] = None
tax: Union[float, None] = None
app = FastAPI()
@app.post("/items/")
async def create_item(item: Item):
return item
これは、**Pydantic** がdataclasses を内部的にサポートしているため、引き続きサポートされています。
そのため、Pydanticを明示的に使用しない上記のコードでも、FastAPIはPydanticを使用して、それらの標準データクラスをPydantic独自のフレーバーのデータクラスに変換しています。
そしてもちろん、同じことがサポートされています。
- データ検証
- データシリアライゼーション
- データドキュメントなど
これはPydanticモデルと同じように機能します。そして、実際にはPydanticを使用して、同じ方法で実現されています。
情報
データクラスはPydanticモデルができることすべてを実行できるわけではないことに注意してください。
そのため、Pydanticモデルを使用する必要がある場合があります。
しかし、たくさんのデータクラスが手元にある場合、FastAPIを使用してWeb APIを強化するための素晴らしいトリックです。🤓
response_model におけるデータクラス¶
response_model パラメータで dataclasses を使用することもできます。
from dataclasses import dataclass, field
from typing import List, Union
from fastapi import FastAPI
@dataclass
class Item:
name: str
price: float
tags: List[str] = field(default_factory=list)
description: Union[str, None] = None
tax: Union[float, None] = None
app = FastAPI()
@app.get("/items/next", response_model=Item)
async def read_next_item():
return {
"name": "Island In The Moon",
"price": 12.99,
"description": "A place to be playin' and havin' fun",
"tags": ["breater"],
}
データクラスは自動的にPydanticデータクラスに変換されます。
こうすることで、そのスキーマがAPIドキュメントのユーザーインターフェースに表示されます。
ネストされたデータ構造におけるデータクラス¶
dataclasses を他の型アノテーションと組み合わせて、ネストされたデータ構造を作成することもできます。
場合によっては、自動的に生成されるAPIドキュメントでエラーが発生した場合など、Pydanticバージョンの dataclasses を使用する必要がある場合があります。
その場合は、標準の dataclasses をドロップイン置換である pydantic.dataclasses に置き換えるだけです。
from dataclasses import field # (1)
from typing import List, Union
from fastapi import FastAPI
from pydantic.dataclasses import dataclass # (2)
@dataclass
class Item:
name: str
description: Union[str, None] = None
@dataclass
class Author:
name: str
items: List[Item] = field(default_factory=list) # (3)
app = FastAPI()
@app.post("/authors/{author_id}/items/", response_model=Author) # (4)
async def create_author_items(author_id: str, items: List[Item]): # (5)
return {"name": author_id, "items": items} # (6)
@app.get("/authors/", response_model=List[Author]) # (7)
def get_authors(): # (8)
return [ # (9)
{
"name": "Breaters",
"items": [
{
"name": "Island In The Moon",
"description": "A place to be playin' and havin' fun",
},
{"name": "Holy Buddies"},
],
},
{
"name": "System of an Up",
"items": [
{
"name": "Salt",
"description": "The kombucha mushroom people's favorite",
},
{"name": "Pad Thai"},
{
"name": "Lonely Night",
"description": "The mostests lonliest nightiest of allest",
},
],
},
]
-
標準の
dataclassesからfieldをインポートします。 -
pydantic.dataclassesはdataclassesのドロップイン置換です。 -
Authorデータクラスには、Itemデータクラスのリストが含まれています。 -
Authorデータクラスは、response_modelパラメータとして使用されます。 -
リクエストボディとして、データクラスと共に他の標準の型アノテーションを使用できます。
この場合、
Itemデータクラスのリストです。 -
ここでは、データクラスのリストである
itemsを含む辞書を返しています。FastAPI は、データを JSON にシリアライズする機能を備えています。
-
ここでは、
response_modelはAuthorデータクラスのリストの型アノテーションを使用しています。繰り返しになりますが、
dataclassesと標準の型アノテーションを組み合わせることができます。 -
この *パス操作関数* は
async defではなく、通常のdefを使用していることに注意してください。FastAPI では、常に必要に応じて
defとasync defを組み合わせることができます。どちらをいつ使用するかについての復習が必要な場合は、
asyncとawaitに関するドキュメントの *「急いでいる場合」* のセクションをご覧ください。 -
この *パス操作関数* はデータクラスを返していませんが（返すこともできます）、内部データを持つ辞書のリストを返しています。
FastAPI は、
response_modelパラメーター（データクラスを含む）を使用してレスポンスを変換します。
dataclasses を他の型アノテーションとさまざまな組み合わせで組み合わせて、複雑なデータ構造を形成できます。
具体的な詳細については、上記のコード内アノテーションのヒントをご覧ください。
詳細はこちら¶
dataclasses を他の Pydantic モデルと組み合わせたり、それらを継承したり、独自のモデルに含めたりすることもできます。
詳細については、データクラスに関する Pydantic ドキュメントをご覧ください。
バージョン¶
これは FastAPI バージョン 0.67.0 以降で使用できます。🔖