FastAPI 依存性注入

FastAPIは、強力で簡潔な依存性注入システムを提供します。

依存性注入は設計パターンの一種で、データベース接続、認証、パラメータ検証などの共通ロジックを再利用可能なコンポーネントとして抽出し、ルートで必要に応じて使用できるようにします。


依存性注入とは

簡単に言うと、依存とは、パス操作関数と同じパラメータ(クエリパラメータ、パスパラメータ、リクエストボディなど)を使用できる関数です。FastAPIはルート関数を実行する前に自動的に依存関数を呼び出し、その戻り値をルート関数に渡します。

例

from typing import Annotated
from fastapi import Depends, FastAPI

app = FastAPI()


# 1. 依存関数を定義
def common_parameters(q: str | None = None, skip: int = 0, limit: int = 100):
    return {"q": q, "skip": skip, "limit": limit}


# 2. ルートで依存を使用
@app.get("/items/")
async def read_items(commons: dict = Depends(common_parameters)):
    # commons は依存関数の戻り値を受け取る
    return commons


@app.get("/users/")
async def read_users(commons: dict = Depends(common_parameters)):
    # 複数のルートで同じ依存を再利用できる
    return commons

コードの説明:

部分説明
common_parameters依存関数。共通のクエリパラメータを処理する
Depends(common_parameters)宣言するパラメータcommonsの値は依存関数から取得される
commons: dict依存関数が返す辞書を受け取る

依存関数とパス操作関数は同じパラメータ宣言方法を使用します。FastAPIが依存関数のパラメータを自動的に解析します。つまり、依存関数もクエリパラメータ、パスパラメータ、リクエストボディなどを使用できます。


依存の実行フロー

リクエストが到着したときのFastAPIの処理順序:

  1. ルート関数とその依存を識別する
  2. 依存関数を実行する(依存の順番に従う)
  3. 依存関数の戻り値をルート関数に渡す
  4. ルート関数を実行する

クラスを依存として使用

関数の他に、クラスを依存として使用することもできます:

例

from typing import Annotated
from fastapi import Depends, FastAPI

app = FastAPI()


# クラスで依存を宣言
class CommonQueryParams:
    def __init__(self, q: str | None = None, skip: int = 0, limit: int = 100):
        self.q = q
        self.skip = skip
        self.limit = limit


# クラスを依存として使用
@app.get("/items/")
async def read_items(commons: Annotated[CommonQueryParams, Depends()]):
    return {"q": commons.q, "skip": commons.skip, "limit": commons.limit}

当 Depends()パラメータを渡さない場合、FastAPIは自動的にパラメータの型注釈(CommonQueryParams)を依存として使用します。


子依存

依存は自身の依存を持つことができ、依存チェーンを形成します:

例

from typing import Annotated
from fastapi import Depends, FastAPI

app = FastAPI()


# 依存関数
def query_extractor(q: str | None = None):
    return q


# 子依存:query_extractor に依存
def query_checker(q: str = Depends(query_extractor)):
    if q == "admin":
        # 子依存は検証を行うことができる
        return q + " (checked)"
    return q


# ルートは子依存を使用
@app.get("/items/")
async def read_items(q: str = Depends(query_checker)):
    return {"q": q}

実行フロー:query_extractor -> query_checker-> ルート関数


デコレータで依存を使用

依存の副作用(権限チェックなど)のみが必要で、戻り値が不要な場合があります。デコレータのdependenciesパラメータで宣言できます:

例

from fastapi import Depends, FastAPI, Header, HTTPException

app = FastAPI()


# 依存:APIキーを検証
async def verify_api_key(x_api_key: str = Header()):
    if x_api_key != "secret-key":
        raise HTTPException(status_code=400, detail="X-API-Key invalid")


# デコレータで依存を使用。戻り値は不要
@app.get("/items/", dependencies=[Depends(verify_api_key)])
async def read_items():
    return [{"item": "Foo"}]


# ルートグループ全体に依存を使用
@app.get("/users/", dependencies=[Depends(verify_api_key)])
async def read_users():
    return [{"user": "Bar"}]

グローバル依存

ではFastAPIインスタンス上でグローバル依存を宣言でき、すべてのルートに適用されます:

例

from fastapi import Depends, FastAPI, Header, HTTPException

async def verify_token(x_token: str = Header()):
    if x_token != "fake-super-secret-token":
        raise HTTPException(status_code=400, detail="X-Token header invalid")


# グローバル依存:すべてのルートでトークン検証が必要
app = FastAPI(dependencies=[Depends(verify_token)])


@app.get("/items/")
async def read_items():
    return [{"item": "Foo"}]


@app.get("/users/")
async def read_users():
    return [{"user": "Bar"}]

yieldを使用する依存

依存がクリーンアップ操作(データベース接続のクローズなど)を実行する必要がある場合は、使用するyield:

例

from typing import Annotated
from fastapi import Depends, FastAPI

app = FastAPI()


# yieldを使用する依存:リクエスト前に接続を作成し、リクエスト後に接続を閉じる
def get_db():
    db = "database_connection"  # データベース接続の作成をシミュレート
    try:
        yield db  # リクエスト処理中にデータベース接続を提供
    finally:
        print("データベース接続を閉じる")  # リクエスト完了後にリソースをクリーンアップ


@app.get("/items/")
async def read_items(db: str = Depends(get_db)):
    return {"db": db}

実行フロー:

  1. リクエストが到着したら、実行するyieldより前のコードを実行し、データベース接続を作成する
  2. yield接続をルート関数に渡す
  3. ルート関数の実行が完了したら、実行するfinallyブロック内のクリーンアップコードを実行する

yield依存は、データベース接続やファイルハンドルなど、クリーンアップが必要なリソースの管理に最適です。ルート関数が例外をスローしたかどうかに関係なく、クリーンアップコードは実行されます。


まとめ

  • 依存性注入は共通ロジックを再利用可能な関数やクラスとして抽出する
  • を使用してDepends()ルート関数のパラメータで依存を宣言する
  • 依存はネストして依存チェーンを形成できる
  • デコレータのdependenciesパラメータは戻り値が不要な依存に使用する
  • を使用するyield依存はリソースのクリーンアップをサポートする
  • グローバル依存はすべてのルートに適用される
その他の拡張