FastAPI エンドポイントのテスト
FastAPI で実装した Web アプリケーションでも、ここまでに学んだ pytest の仕組みを使って API エンドポイントをテストできます。FastAPI には TestClient(テストクライアント)と呼ばれる、API に HTTP リクエストを送って動作を検証できるクライアントが用意されています。実際の HTTP サーバを起動せずに、テストプロセスの中で動作が完結します。
1. TestClient でエンドポイントを呼び出す
書き方は以下のとおりです。
from fastapi.testclient import TestClient
from main import app
client = TestClient(関数名)
def test_関数名():
response = client.<HTTPメソッド>(エンドポイントのパス)
assert response.status_code == <期待するステータスコード>
assert response.json() == <期待するレスポンスボディ>
実際にヘルスチェックエンドポイントを呼び出すテストは、以下のようになります。
from fastapi.testclient import TestClient
from main import app
client = TestClient(app)
def test_health():
response = client.get("/health")
assert response.status_code == 200
assert response.json() == {"status": "ok"}
TestClient(app) で FastAPI アプリケーションを受け取り、client.get(...) や client.post(...) でエンドポイントを呼び出します。レスポンスは response.status_code でステータスコードを、response.json() でレスポンスボディを取り出せます。
2. DB 依存をテスト用に差し替える
実運用の DB にテストで触れると、他のテストに影響したり実行時間が長くなったりします。FastAPI では、エンドポイントが Depends(get_db) のように依存注入している場合、app.dependency_overrides を使ってテスト用の DB セッションに差し替えられます。
書き方は以下のとおりです。
関数名.dependency_overrides[元の依存関数] = <テスト用の代替関数>
実際にテスト用のインメモリ SQLite に差し替える例は、以下のようになります。
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from main import app, get_db
# テスト用のインメモリ SQLite を用意する
engine = create_engine("sqlite:///:memory:")
SQLModel.metadata.create_all(engine)
def get_test_db():
with Session(engine) as session:
yield session
# 本番の get_db をテスト用の get_test_db に差し替える
app.dependency_overrides[get_db] = get_test_db
client = TestClient(app)
def test_create_user():
response = client.post("/users", json={"name": "yamada"})
assert response.status_code == 201
assert response.json()["name"] == "yamada"
app.dependency_overrides[get_db] = get_test_db と書くことで、テスト中は本番の DB セッションの代わりにインメモリ SQLite のセッションが使われます。テスト終了後に差し替えを元に戻したい場合は app.dependency_overrides.clear() を呼び出します。