FastAPI テスト

FastAPI は Starlette ベースのTestClient便利なテストサポートを提供し、サーバーを起動せずに API のリクエストとレスポンスをテストできます。


依存関係のインストール

TestClientに基づいてhttpx、インストールが必要です:

pip install httpx

基本テスト

を使用TestClientテストクライアントを作成し、使用するのと同じようにhttpxリクエストを送信します:

例

from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()


@app.get("/")
async def root():
    return {"message": "Hello World"}


# テストクライアントを作成
client = TestClient(app)


# テスト関数
def test_root():
    response = client.get("/")
    assert response.status_code == 200
    assert response.json() == {"message": "Hello World"}

TestClientFastAPI アプリケーションを直接呼び出し、ネットワーク層を経由しないため、テスト速度は非常に高速です。Uvicorn サーバーを起動する必要はありません。


さまざまなリクエストタイプのテスト

例

from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import BaseModel

app = FastAPI()


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


@app.post("/items/")
async def create_item(item: Item):
    return {"name": item.name, "price": item.price}


@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    return {"item_id": item_id, "name": item.name}


@app.delete("/items/{item_id}")
async def delete_item(item_id: int):
    return {"deleted": item_id}


client = TestClient(app)


# POST リクエストのテスト
def test_create_item():
    response = client.post(
        "/items/",
        json={"name": "Foo", "price": 42.0},  # JSON リクエストボディを送信
    )
    assert response.status_code == 200
    assert response.json() == {"name": "Foo", "price": 42.0}


# GET リクエストのテスト
def test_read_item():
    response = client.get("/items/1")
    assert response.status_code == 200
    assert response.json() == {"item_id": 1}


# PUT リクエストのテスト
def test_update_item():
    response = client.put(
        "/items/1",
        json={"name": "Bar", "price": 50.0},
    )
    assert response.status_code == 200


# DELETE リクエストのテスト
def test_delete_item():
    response = client.delete("/items/1")
    assert response.status_code == 200
    assert response.json() == {"deleted": 1}

クエリパラメータとリクエストヘッダーのテスト

例

from typing import Annotated
from fastapi import FastAPI, Header
from fastapi.testclient import TestClient

app = FastAPI()


@app.get("/items/")
async def read_items(
    skip: int = 0,
    limit: int = 10,
    x_token: Annotated[str | None, Header()] = None,
):
    return {"skip": skip, "limit": limit, "x_token": x_token}


client = TestClient(app)


# クエリパラメータのテスト
def test_read_items_with_params():
    response = client.get("/items/?skip=5&limit=20")
    assert response.status_code == 200
    assert response.json() == {"skip": 5, "limit": 20, "x_token": None}


# リクエストヘッダーのテスト
def test_read_items_with_header():
    response = client.get(
        "/items/",
        headers={"X-Token": "fake-token"},  # カスタムリクエストヘッダーを送信
    )
    assert response.status_code == 200
    assert response.json()["x_token"] == "fake-token"

例外応答のテスト

例

from fastapi import FastAPI, HTTPException
from fastapi.testclient import TestClient

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 0:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}


client = TestClient(app)


# 正常なレスポンスのテスト
def test_read_item():
    response = client.get("/items/1")
    assert response.status_code == 200


# エラーレスポンスのテスト
def test_read_item_not_found():
    response = client.get("/items/0")
    assert response.status_code == 404
    assert response.json() == {"detail": "Item not found"}


# バリデーションエラーのテスト
def test_read_item_invalid_id():
    response = client.get("/items/foo")
    assert response.status_code == 422  # バリデーション失敗

pytest を使用してテストを実行する

テストコードを次の名前で保存しますtest_main.py、そして実行します:

$ pytest test_main.py

# 显示详细输出
$ pytest test_main.py -v

# 显示 print 输出
$ pytest test_main.py -s

pytest は自動的に次で始まるtest_ファイルと関数を検出します。


テストでの依存関係のオーバーライド

テストでは、特定の依存関係(データベース接続、認証ロジックなど)をオーバーライドする必要があるかもしれません:

例

from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient

app = FastAPI()


# 実際の依存関係関数
def get_query_param():
    return "real_value"


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


client = TestClient(app)


def test_with_override():
    # 依存関係をオーバーライド
    app.dependency_overrides[get_query_param] = lambda: "test_value"

    response = client.get("/items/")
    assert response.json() == {"query": "test_value"}

    # オーバーライドをクリア
    app.dependency_overrides.clear()

app.dependency_overridesテスト内で任意の依存関係関数を置き換えることができ、データベース接続や外部 API 呼び出しなどのシナリオをモックするのに最適です。テスト完了後はオーバーライドをクリアすることを忘れないでください。


まとめ

  • を使用TestClientFastAPI アプリケーションを直接テストし、サーバーを起動する必要はありません
  • GET、POST、PUT、DELETE などすべての HTTP メソッドのテストをサポート
  • クエリパラメータ、リクエストヘッダー、リクエストボディ、例外応答などをテストできます
  • を使用app.dependency_overridesテスト内で依存関係をオーバーライド
  • pytest と組み合わせることで、テストを簡単に整理して実行できます
その他の拡張