FastAPIとルーターのバリデーション: 実践ガイド

by mr_osson 投稿日:

FastAPIとPydanticの組み合わせ

FastAPIは、Pythonの高速なWebフレームワークで、Pydanticとの組み合わせにより、強力なデータバリデーションとシリアライゼーションを提供します。

Pydanticとは

Pydanticは、Pythonのデータパーサとバリデータで、Pythonの型ヒントを利用しています。これにより、データのバリデーションとエラーハンドリングが容易になります。

FastAPIとPydanticの組み合わせの利点

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

  1. 型チェック: Pydanticは、Pythonの型ヒントを利用してデータの型をチェックします。これにより、データが期待した型であることを保証できます。
  2. 自動ドキュメンテーション: FastAPIは、Pydanticモデルから自動的にAPIドキュメンテーションを生成します。
  3. エラーハンドリング: Pydanticは、データが無効な場合にエラーを自動的に生成します。これにより、エラーハンドリングが容易になります。

次のセクションでは、具体的なコード例を通じて、これらの概念を詳しく説明します。

モデルの記述と型チェック

FastAPIとPydanticを使用すると、データモデルを簡単に記述し、型チェックを行うことができます。以下に具体的なコード例を示します。

from pydantic import BaseModel
from typing import Optional

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

上記のコードでは、Itemという名前のPydanticモデルを定義しています。このモデルは以下のフィールドを持っています:

  1. name: 文字列型で、必須のフィールドです。
  2. description: 文字列型で、オプションのフィールドです。デフォルト値はNoneです。
  3. price: 浮動小数点型で、必須のフィールドです。
  4. tax: 浮動小数点型で、オプションのフィールドです。デフォルト値はNoneです。

このモデルを使用すると、FastAPIは自動的に以下のバリデーションを行います:

  • nameとpriceは必須であること
  • nameとdescriptionが文字列であること
  • priceとtaxが浮動小数点数であること

これらのバリデーションは、APIリクエストの受信時に自動的に行われます。これにより、APIエンドポイントのコードは、バリデーションの詳細を気にすることなく、ビジネスロジックに集中することができます。次のセクションでは、必須チェックとデフォルト値について詳しく説明します。

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

FastAPIとPydanticを使用すると、必須フィールドのチェックとデフォルト値の設定が容易になります。以下に具体的なコード例を示します。

from pydantic import BaseModel
from typing import Optional

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

上記のコードでは、nameとpriceは必須フィールドであり、descriptionとtaxはオプションのフィールドです。オプションのフィールドは、デフォルト値が設定されています（この場合はNone）。

FastAPIとPydanticは、以下のバリデーションを自動的に行います:

  • nameとpriceが提供されていることを確認します。これらのフィールドが欠落している場合、FastAPIは400エラーを返し、どのフィールドが欠落しているかをクライアントに通知します。
  • descriptionとtaxが提供されていない場合、それらのデフォルト値（この場合はNone）が使用されます。

この機能により、APIエンドポイントのコードは、必須フィールドのチェックやデフォルト値の設定を手動で行う必要がなくなり、ビジネスロジックに集中することができます。次のセクションでは、形式チェックについて詳しく説明します。

形式チェック

FastAPIとPydanticを使用すると、データの形式チェックも容易になります。以下に具体的なコード例を示します。

from pydantic import BaseModel, EmailStr
from typing import Optional

class User(BaseModel):
    name: str
    email: EmailStr
    age: Optional[int] = None

上記のコードでは、Userという名前のPydanticモデルを定義しています。このモデルは以下のフィールドを持っています:

  1. name: 文字列型で、必須のフィールドです。
  2. email: EmailStr型で、必須のフィールドです。この型は、値が有効なメールアドレスであることを確認します。
  3. age: 整数型で、オプションのフィールドです。デフォルト値はNoneです。

FastAPIとPydanticは、以下のバリデーションを自動的に行います:

  • nameとemailが提供されていることを確認します。これらのフィールドが欠落している場合、FastAPIは400エラーを返し、どのフィールドが欠落しているかをクライアントに通知します。
  • emailが有効なメールアドレスであることを確認します。無効なメールアドレスが提供された場合、FastAPIは400エラーを返し、無効なメールアドレスが提供されたことをクライアントに通知します。
  • ageが提供されていない場合、そのデフォルト値（この場合はNone）が使用されます。

この機能により、APIエンドポイントのコードは、形式チェックを手動で行う必要がなくなり、ビジネスロジックに集中することができます。次のセクションでは、値チェックについて詳しく説明します。

値チェック

FastAPIとPydanticを使用すると、データの値チェックも容易になります。以下に具体的なコード例を示します。

from pydantic import BaseModel, EmailStr, PositiveInt
from typing import Optional

class User(BaseModel):
    name: str
    email: EmailStr
    age: Optional[PositiveInt] = None

上記のコードでは、Userという名前のPydanticモデルを定義しています。このモデルは以下のフィールドを持っています:

  1. name: 文字列型で、必須のフィールドです。
  2. email: EmailStr型で、必須のフィールドです。この型は、値が有効なメールアドレスであることを確認します。
  3. age: PositiveInt型で、オプションのフィールドです。デフォルト値はNoneです。この型は、値が正の整数であることを確認します。

FastAPIとPydanticは、以下のバリデーションを自動的に行います:

  • nameとemailが提供されていることを確認します。これらのフィールドが欠落している場合、FastAPIは400エラーを返し、どのフィールドが欠落しているかをクライアントに通知します。
  • emailが有効なメールアドレスであることを確認します。無効なメールアドレスが提供された場合、FastAPIは400エラーを返し、無効なメールアドレスが提供されたことをクライアントに通知します。
  • ageが正の整数であることを確認します。無効な年齢（例えば、負の数）が提供された場合、FastAPIは400エラーを返し、無効な年齢が提供されたことをクライアントに通知します。
  • ageが提供されていない場合、そのデフォルト値（この場合はNone）が使用されます。

この機能により、APIエンドポイントのコードは、値チェックを手動で行う必要がなくなり、ビジネスロジックに集中することができます。次のセクションでは、エラーハンドリングについて詳しく説明します。

エラーハンドリング

FastAPIとPydanticを使用すると、エラーハンドリングも容易になります。以下に具体的なコード例を示します。

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr, PositiveInt, ValidationError
from typing import Optional

app = FastAPI()

class User(BaseModel):
    name: str
    email: EmailStr
    age: Optional[PositiveInt] = None

@app.post("/users/")
async def create_user(user: User):
    return {"user": user}

上記のコードでは、/users/エンドポイントにPOSTリクエストを送信すると、FastAPIとPydanticは自動的に以下のバリデーションを行います:

  • nameとemailが提供されていることを確認します。これらのフィールドが欠落している場合、FastAPIは400エラーを返し、どのフィールドが欠落しているかをクライアントに通知します。
  • emailが有効なメールアドレスであることを確認します。無効なメールアドレスが提供された場合、FastAPIは400エラーを返し、無効なメールアドレスが提供されたことをクライアントに通知します。
  • ageが正の整数であることを確認します。無効な年齢（例えば、負の数）が提供された場合、FastAPIは400エラーを返し、無効な年齢が提供されたことをクライアントに通知します。
  • ageが提供されていない場合、そのデフォルト値（この場合はNone）が使用されます。

これらのエラーメッセージは、クライアントがエラーの原因を理解し、修正するのに役立ちます。また、これらのエラーメッセージは、APIの自動ドキュメンテーションにも表示されます。

この機能により、APIエンドポイントのコードは、エラーハンドリングを手動で行う必要がなくなり、ビジネスロジックに集中することができます。以上が、FastAPIとPydanticを使用したエラーハンドリングの基本的な説明です。さらに詳しい情報は、公式ドキュメンテーションを参照してください。この記事が、FastAPIとPydanticの強力な組み合わせを理解するのに役立つことを願っています。それでは、Happy Coding! 🚀

コメントする

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です