fastapi-router-creator

FastAPI ルーターの作成

このスキルでは、保守性とスケーラビリティを重視し、モジュール化された整理しやすい FastAPI ルーターの作成方法を説明します。

ルーティング戦略

1. モジュール化ルーターパターン（標準）

FastAPI で最も一般的かつ推奨されているアプローチです。

構成：

src/api/v1/endpoints/
├── users.py
├── items.py
└── auth.py

実装：

src/api/v1/endpoints/users.py:

from fastapi import APIRouter

router = APIRouter()

@router.get("/")
async def get_users():
    ...

src/api/v1/api.py（集約ファイル）:

from fastapi import APIRouter
from src.api.v1.endpoints import users, items

api_router = APIRouter()
api_router.include_router(users.router, prefix="/users", tags=["users"])
api_router.include_router(items.router, prefix="/items", tags=["items"])

2. ファイルベースのルーティング（fastapi-router）

ファイル構成に応じて URL が決まる、Next.js のような使い方です。（fastapi-router ライブラリまたはカスタムウォーカーが必要です。）

構成：

src/app/
├── api/
│   ├── users/
│   │   ├── route.py  # Handles /api/users
│   │   └── [id]/
│   │       └── route.py # Handles /api/users/{id}

ベストプラクティス

1. プレフィックス：すべてのエンドポイントのデコレーター内ではなく、ルーターの追加時にプレフィックスを指定します。
2. タグ：タグを使って、OpenAPI ドキュメント内のエンドポイントをグループ化します。
3. 依存関係：ルーター内のすべてのエンドポイントに適用する依存関係（認証など）は、ルーターレベルで適用します。

   router = APIRouter(dependencies=[Depends(get_current_active_user)])
   

4. バージョン：API バージョン（v1、v2）ごとにルーターを名前空間で分けます。