FastAPI Development

目次

• 概要
• 使用する場合
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

async/await サポート、自動 API ドキュメント生成、Pydantic による型検証、依存性注入、JWT 認証、SQLAlchemy ORM 統合を備えた FastAPI を使用して、高速でモダンな Python API を構築します。

使用する場合

• 高性能な Python REST API を構築する場合
• 非同期 API エンドポイントを作成する場合
• 自動 OpenAPI/Swagger ドキュメント生成を実装する場合
• Python の型ヒントを活用して検証する場合
• 非同期サポート付きマイクロサービスを構築する場合
• データ検証に Pydantic を統合する場合

クイックスタート

最小限の動作例:

# main.py
from fastapi import FastAPI, HTTPException, status
from fastapi.middleware.cors import CORSMiddleware
from contextlib import asynccontextmanager
import logging

# Setup logging
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

# Create FastAPI instance
app = FastAPI(
    title="API Service",
    description="A modern FastAPI application",
    version="1.0.0",
    docs_url="/api/docs",
    openapi_url="/api/openapi.json"
)

# Add CORS middleware
app.add_middleware(
    CORSMiddleware,
    allow_origins=["http://localhost:3000"],
    allow_credentials=True,
    allow_methods=["*"],
// ... (see reference guides for full implementation)

リファレンスガイド

references/ ディレクトリの詳細実装:

ベストプラクティス

✅ やるべきこと

• I/O 操作には async/await を使用する
• 検証に Pydantic を活用する
• サービスに依存性注入を使用する
• HTTPException を使用した適切なエラーハンドリングを実装する
• 自動 OpenAPI ドキュメント生成のために型ヒントを使用する
• ビジネスロジック用にサービスレイヤーを作成する
• 保護されたルートに認証を実装する
• 設定に環境変数を使用する
• 適切な HTTP ステータスコードを返す
• ドキュメント文字列とタグを使用してエンドポイントをドキュメント化する

❌ やってはいけないこと

• 同期的なデータベース操作を使用する
• 検証なしにユーザー入力を信頼する
• コード内にシークレットを保存する
• 型ヒントを無視する
• レスポンスでデータベースモデルを返す
• ルートハンドラー内に認証を実装する
• 可変のデフォルト引数を使用する
• クエリパラメーターの検証を忘れる
• 本番環境でスタックトレースを公開する