FastAPIとPydanticスキーマの活用

FastAPIとPydanticの基本

FastAPIは、Pythonの非常に高速な（高性能）、使いやすい、モダンな、高速（高性能）なWebフレームワークです。これは、Python 3.6以降の型ヒントに基づいています。

一方、Pydanticは、データパーサとバリデータであり、Pythonの型ヒントを使用して、データの変換と検証を行います。

FastAPIとPydanticを組み合わせることで、以下のような利点が得られます：

1. コードの簡素化：Pydanticモデルを使用してリクエストボディを宣言すると、FastAPIは自動的にリクエストを解析し、適切な型に変換し、バリデーションを行います。これにより、手動でデータの検証や変換を行う必要がなくなります。

2. 自動ドキュメンテーション：FastAPIは、Pydanticモデルから自動的にAPIのスキーマを生成し、対話式のAPIドキュメンテーションを提供します。

3. エディタのサポート：Pydanticモデルと型ヒントを使用すると、エディタはコードの補完やエラーチェックを提供できます。これにより、開発速度が向上し、エラーが減少します。

次のセクションでは、Pydanticスキーマの定義と利用について詳しく説明します。このセクションでは、Pydanticモデルの作成方法、FastAPIエンドポイントでの使用方法、バリデーションルールの追加方法について学びます。

Pydanticスキーマの定義と利用

Pydanticは、Pythonの型ヒントを使用してデータの変換と検証を行うデータパーサとバリデータです。Pydanticモデルは、データの形状を定義し、その形状に基づいてデータの変換と検証を行います。

Pydanticモデルの作成

Pydanticモデルは、Pythonのクラスを使用して定義します。各フィールドはクラス属性として定義され、その型はPythonの型ヒントを使用して指定されます。

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

この例では、Itemモデルにはname、description、price、taxの4つのフィールドがあります。nameとpriceは必須ですが、descriptionとtaxはオプションです。

FastAPIエンドポイントでの使用

FastAPIエンドポイントでは、Pydanticモデルを使用してリクエストボディを宣言することができます。FastAPIは、リクエストボディを自動的に解析し、Pydanticモデルに変換します。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
async def create_item(item: Item):
    return item

この例では、create_item関数はItemモデルのインスタンスを引数として受け取ります。FastAPIは、リクエストボディをItemモデルに変換し、バリデーションを行います。

次のセクションでは、バリデーションと型チェックについて詳しく説明します。このセクションでは、Pydanticのバリデーション機能の活用方法と、型チェックを使用してデータの整合性を保つ方法について学びます。

バリデーションと型チェック

Pydanticは、Pythonの型ヒントを使用してデータの変換と検証を行う強力なツールです。これにより、データが期待する形状と一致することを保証し、エラーを早期に検出することができます。

バリデーション

Pydanticモデルは、データがモデルの定義に一致することを確認するためのバリデーションを提供します。これには、フィールドの存在、フィールドの型、およびカスタムバリデーションルールのチェックが含まれます。

from pydantic import BaseModel, ValidationError

class Item(BaseModel):
    name: str
    price: float

try:
    Item(name="Apple", price="not a number")
except ValidationError as e:
    print(e)

この例では、priceフィールドに文字列を渡すと、Pydanticは型が一致しないためにValidationErrorを発生させます。

型チェック

Pythonの型ヒントは、Pydanticがデータのバリデーションを行うための基礎を提供します。型ヒントは、データが期待する型であることを保証します。

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float

item = Item(name="Apple", price=0.5)

print(type(item.price))  # <class 'float'>

この例では、priceフィールドはfloat型であることが保証されています。したがって、item.priceの型はfloatになります。

次のセクションでは、型ヒントとJSONスキーマについて詳しく説明します。このセクションでは、PydanticモデルからJSONスキーマを生成する方法と、そのスキーマを使用してAPIのドキュメンテーションを自動生成する方法について学びます。

型ヒントとJSONスキーマ

Pythonの型ヒントとPydanticのJSONスキーマ機能は、APIのドキュメンテーションとデータのバリデーションを自動化するための強力なツールです。

型ヒント

Pythonの型ヒントは、変数や関数の引数、戻り値の期待する型を明示的に指定する機能です。これにより、開発者はコードの意図をより明確に表現でき、エディタやIDEはより効果的な補完やエラーチェックを提供できます。

from typing import List
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float
    tags: List[str] = []

この例では、Itemモデルのtagsフィールドは文字列のリストであることが期待されています。

JSONスキーマ

Pydanticは、モデルの定義からJSONスキーマを自動的に生成する機能を提供します。JSONスキーマは、JSONデータの形状を記述するためのメタデータです。

FastAPIは、Pydanticモデルから生成されたJSONスキーマを使用して、APIのドキュメンテーションを自動生成します。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float

@app.post("/items/")
async def create_item(item: Item):
    return item

この例では、FastAPIは/items/エンドポイントのドキュメンテーションを自動的に生成します。ドキュメンテーションには、リクエストボディの期待する形状（Itemモデル）と、レスポンスボディの形状（同じくItemモデル）が含まれます。

次のセクションでは、必須チェックとデフォルト値について詳しく説明します。このセクションでは、Pydanticモデルのフィールドを必須にする方法、デフォルト値を設定する方法、そしてこれらがどのようにAPIの振る舞いに影響を与えるかについて学びます。

必須チェックとデフォルト値

Pydanticモデルでは、フィールドが必須かどうかを指定することができます。また、フィールドにデフォルト値を設定することも可能です。

必須チェック

フィールドが必須であることを指定するには、フィールドの型ヒントだけを指定します。これにより、そのフィールドが存在しない場合にはバリデーションエラーが発生します。

from pydantic import BaseModel

class Item(BaseModel):
    name: str  # 必須フィールド
    description: str = None  # オプションフィールド

この例では、nameフィールドは必須であり、descriptionフィールドはオプションです。

デフォルト値

フィールドにデフォルト値を設定するには、フィールドの定義で等号（=）を使用します。デフォルト値が設定されているフィールドは、オプションとなります。

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str = "No description"  # デフォルト値が設定されています

この例では、descriptionフィールドにはデフォルト値が設定されています。したがって、このフィールドはオプションとなり、ユーザーが値を提供しない場合にはデフォルト値が使用されます。

以上が、Pydanticの必須チェックとデフォルト値の基本的な使い方です。これらの機能を活用することで、APIの振る舞いをより細かく制御し、ユーザーにとって使いやすいAPIを提供することができます。次のセクションでは、形式チェックと値チェックについて詳しく説明します。このセクションでは、Pydanticの形式チェックと値チェックの機能を活用して、データの整合性を保つ方法について学びます。

形式チェックと値チェック

Pydanticは、データの形状だけでなく、データの値もチェックする機能を提供しています。これにより、データが特定の条件を満たすことを保証することができます。

形式チェック

Pydanticは、フィールドの値が特定の形式に一致することを確認するための形式チェックを提供します。例えば、文字列が有効なメールアドレスであること、または数値が特定の範囲内にあることを確認することができます。

from pydantic import BaseModel, EmailStr

class User(BaseModel):
    name: str
    email: EmailStr  # メールアドレス形式チェック

この例では、emailフィールドはEmailStr型であり、Pydanticはこのフィールドの値が有効なメールアドレスであることを確認します。

値チェック

Pydanticは、フィールドの値が特定の条件を満たすことを確認するための値チェックを提供します。例えば、数値が特定の範囲内にあること、または文字列が特定の長さであることを確認することができます。

from pydantic import BaseModel, Field

class Item(BaseModel):
    name: str = Field(..., min_length=1, max_length=100)  # 文字列長チェック
    price: float = Field(..., gt=0)  # 値チェック（0より大きい）

この例では、nameフィールドの長さは1から100の間であること、priceフィールドの値は0より大きいことが必要です。

以上が、Pydanticの形式チェックと値チェックの基本的な使い方です。これらの機能を活用することで、APIの振る舞いをより細かく制御し、ユーザーにとって使いやすいAPIを提供することができます。以上で、FastAPIとPydanticスキーマの活用についての技術記事の作成は完了です。この記事が、FastAPIとPydanticの理解と活用に役立つことを願っています。それでは、Happy coding! 🚀