FastAPI CORS クロスオリジン
CORS(Cross-Origin Resource Sharing、クロスオリジンリソース共有)は、Web ページが異なるドメインからリソースをリクエストすることを許可または制限するセキュリティメカニズムです。フロントエンドとバックエンドを分離して開発する場合、フロントエンドページは通常、異なるドメインまたはポートで実行されるため、バックエンド API に正常にアクセスするには CORS を設定する必要があります。
クロスオリジン問題とは
ブラウザの同一オリジンポリシーにより、Web ページが異なるドメインにリクエストを送信することが制限されます。例:
| フロントエンドのアドレス | バックエンド API のアドレス | クロスオリジンかどうか |
|---|---|---|
http://localhost:3000 | http://localhost:8000 | クロスオリジン(ポートが異なる) |
http://example.com | http://api.example.com | クロスオリジン(ドメインが異なる) |
https://example.com | http://example.com | クロスオリジン(プロトコルが異なる) |
http://example.com | http://example.com/api | 同一オリジン(ドメイン、ポート、プロトコルが同じ) |
同一オリジンの3つの要素:プロトコル、ドメイン、ポート、いずれかが異なればクロスオリジンになります。
CORS を設定する
FastAPI は Starlette のCORSMiddlewareを使用してクロスオリジンを処理します:
例
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# CORS ミドルウェアを設定
app.add_middleware(
CORSMiddleware,
allow_origins=[ # 許可するオリジン(ドメインリスト)
"http://localhost:3000", # フロントエンド開発サーバー
"http://localhost:8080",
],
allow_credentials=True, # Cookie の送信を許可
allow_methods=["*"], # 許可する HTTP メソッド
allow_headers=["*"], # 許可するリクエストヘッダー
)
@app.get("/")
async def root():
return {"message": "Hello World"}
CORS 設定パラメータの詳細
| パラメータ | 型 | 説明 | 推奨値 |
|---|---|---|---|
allow_origins | list[str] | クロスオリジンを許可するオリジンのリスト | 本番環境では具体的なドメインを使用 |
allow_methods | list[str] | 許可する HTTP メソッド | ["GET", "POST", "PUT", "DELETE"] |
allow_headers | list[str] | 許可するリクエストヘッダー | 必要に応じて設定 |
allow_credentials | bool | Cookie と認証情報の送信を許可するかどうか | 認証が必要な場合は True に設定True |
expose_headers | list[str] | フロントエンドがアクセスできるレスポンスヘッダー | 必要に応じて設定 |
max_age | int | プリフライトリクエストのキャッシュ時間(秒) | 600 |
allow_originsを使用すると["*"]すべてのオリジンを許可することを意味しますが、これはallow_credentials=Trueと互換性がありません。Cookie を送信する必要がある場合は、具体的なオリジンを指定する必要があります。
開発環境 vs 本番環境
開発環境
開発時は利便性のため、すべてのオリジンを許可できます:
例
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# 開発環境:すべてのオリジンを許可(開発専用!)
app.add_middleware(
CORSMiddleware,
allow_origins=["*"], # すべてのオリジンを許可
allow_credentials=True,
allow_methods=["*"], # すべてのメソッドを許可
allow_headers=["*"], # すべてのリクエストヘッダーを許可
)
本番環境
本番環境では具体的なオリジンを指定する必要があります:
例
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# 本番環境:特定のドメインのみ許可
app.add_middleware(
CORSMiddleware,
allow_origins=[
"https://example.com", # 本番フロントエンドのドメイン
"https://www.example.com", # www 付きドメイン
],
allow_credentials=True,
allow_methods=["GET", "POST", "PUT", "DELETE"],
allow_headers=["Authorization", "Content-Type"],
max_age=600, # プリフライトリクエストを10分間キャッシュ
)
本番環境で使用することは
allow_origins=["*"]セキュリティ上のリスクであり、クロスサイトリクエストフォージェリ(CSRF)攻撃を引き起こす可能性があります。必ず具体的なフロントエンドのドメインを指定してください。
CORS プリフライトリクエスト
ブラウザは特定のクロスオリジンリクエストを送信する前に、まずOPTIONSプリフライトリクエスト(preflight request)を送信し、サーバーに実際のリクエストを許可するかどうかを問い合わせます。CORS ミドルウェアはプリフライトリクエストを自動的に処理します。
プリフライトが必要なリクエストの条件:
- を使用した
PUT、DELETEなどの非シンプルメソッド - リクエストヘッダーにカスタムフィールドが含まれる(例:
Authorization) Content-Typeではないapplication/x-www-form-urlencoded、multipart/form-data或text/plain
を設定した
max_age後、ブラウザはプリフライトの結果をキャッシュし、指定された時間内にプリフライトリクエストを再送信しないため、ネットワークのオーバーヘッドを削減します。
まとめ
- CORS はブラウザのセキュリティメカニズムであり、フロントエンドとバックエンドを分離した開発では必ず設定する必要があります
- を使用して
CORSMiddlewareクロスオリジンリクエストを処理します - 本番環境では必ず具体的な を指定し
allow_origins、 を使用しないでください["*"] allow_credentials=Trueとallow_origins=["*"]互換性がありません- CORS ミドルウェアはブラウザの OPTIONS プリフライトリクエストを自動的に処理します