FastAPIのCORSMiddlewareによる対応
CORSの仕組みが分かったところで、APIサーバにAccess-Control-Allow-Originヘッダを返す設定を組み込みます。FastAPIには、Starletteが提供するCORSMiddlewareが同梱されており、これをapp.add_middlewareで登録することで実現できます。
1. ミドルウェアの導入
1.1 ミドルウェアの追加
main.pyを以下のように書き換えて保存します。これは、http://localhost:5173からのアクセスを許可するCORSミドルウェアを組み込んだFastAPIアプリケーションです。GET /notesとPUT /notes/{note_id}のルートは変えずに、app.add_middleware(...)の呼び出しを追加した形になります。
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
app.add_middleware(
CORSMiddleware,
allow_origins=["http://localhost:5173"],
allow_methods=["GET", "POST", "PUT", "DELETE", "OPTIONS"],
allow_headers=["Content-Type", "Authorization"],
)
@app.get("/notes")
def list_notes():
return [
{"id": 1, "title": "買い物"},
{"id": 2, "title": "打ち合わせ資料"},
]
@app.put("/notes/{note_id}")
def update_note(note_id: int):
return {"id": note_id, "status": "updated"}
1.2 動作確認
uvicornは--reloadオプションで起動しているので、ファイルの保存でサーバが自動的に再起動されます。ターミナルに以下のようなメッセージが表示されます。
WARNING: WatchFiles detected changes in 'main.py'. Reloading...
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
ブラウザに戻って、http://localhost:5173/を再読み込みしてください。画面に以下のようにノート一覧が表示されれば、CORS対応は成功しています。
Notes
・ 1: 買い物
・ 2: 打ち合わせ資料
レスポンスヘッダにAccess-Control-Allow-Origin: http://localhost:5173が実際に付いていることは、別のターミナルからcurlで確認できます。ブラウザからの呼び出しを再現するため、-H "Origin: http://localhost:5173"でリクエスト元のオリジンを付けて送り、-iオプションでレスポンスヘッダも表示します。
curl -i -H "Origin: http://localhost:5173" http://localhost:8000/notes
以下のような実行結果が表示されます。
HTTP/1.1 200 OK
access-control-allow-origin: http://localhost:5173
content-type: application/json
content-length: 71
[{"id":1,"title":"買い物"},{"id":2,"title":"打ち合わせ資料"}]
access-control-allow-origin: http://localhost:5173の行があれば、CORSヘッダが正しく付与されています。逆に-H "Origin: ..."を付けずに叩くと、ブラウザ以外からの通常のリクエスト扱いになり、このヘッダは付きません(ミドルウェアがオリジン判定して付与するため)。
1.3 コードの解説
from fastapi.middleware.cors import CORSMiddleware
CORSMiddlewareはFastAPIに同梱されているミドルウェアで、Starlette由来の実装が使われます。追加のインストールは不要です。
app.add_middleware(
CORSMiddleware,
allow_origins=["http://localhost:5173"],
...
)
app.add_middlewareで、ミドルウェアクラスとその設定を渡します。ここに登録したミドルウェアは、すべてのリクエストに対して自動的にCORSヘッダの付与とプリフライト(OPTIONS)の応答を行うようになります。
allow_origins=["http://localhost:5173"]
CORSで許可するオリジンをリストで指定します。ここに含まれるオリジンからのリクエストに対してのみ、Access-Control-Allow-Originヘッダが付与されます。複数のオリジンを列挙することもできます。
allow_methods=["GET", "POST", "PUT", "DELETE", "OPTIONS"]
プリフライトリクエストで許可するHTTPメソッドを指定します。OPTIONSはプリフライト自身のメソッドで、通常は明示的に含めておきます。
allow_headers=["Content-Type", "Authorization"]
リクエストで許可するヘッダを列挙します。Content-Type: application/jsonでJSONを送る場合や、Authorizationヘッダでトークンを送る場合はここに含めておく必要があります。
| ⚠️ 「Failed to fetch」がブラウザで解消しない場合 |
|---|
ブラウザは一度受け取ったレスポンス(CORS判定を含む)をキャッシュする場合があります。ミドルウェアを追加したのに画面上でエラーが続く場合は、ブラウザの再読み込みを「スーパーリロード」(ChromeではShift + F5またはCtrl + Shift + R/Cmd + Shift + R)で行い、開発者ツールを開いた状態で「Network」タブのDisable cacheにチェックを入れて再度確認してください。 |
2. プリフライトリクエストの確認
これまで確認してきたGET /notesは「単純リクエスト」に該当するため、ブラウザはOPTIONSを送らずにGETをそのまま投げていました。ここでは、単純リクエストの条件から外れるPUT /notes/{note_id}(main.pyに登録済み)に対して、プリフライト(OPTIONS)が実際に発生することをcurlで確認します。
2.1 プリフライトリクエストの再現
OPTIONSリクエストにプリフライト固有のヘッダを付けて送ります。書き方は以下のとおりです。
curl -X OPTIONS -i \
-H "Origin: 呼び出し元のオリジン" \
-H "Access-Control-Request-Method: 本来送るメソッド" \
-H "Access-Control-Request-Headers: 本来送るヘッダ" \
URL
上記の書式に沿って、本来送りたいメソッドPUTと、本来付けたいヘッダContent-Typeを伝えるプリフライトを、別のターミナルから送ります。
curl -X OPTIONS -i \
-H "Origin: http://localhost:5173" \
-H "Access-Control-Request-Method: PUT" \
-H "Access-Control-Request-Headers: Content-Type" \
http://localhost:8000/notes/1
以下のような実行結果が表示されます。
HTTP/1.1 200 OK
vary: Origin
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS
access-control-max-age: 600
access-control-allow-headers: Accept, Accept-Language, Authorization, Content-Language, Content-Type
access-control-allow-origin: http://localhost:5173
access-control-allow-methodsにPUTが、access-control-allow-headersにContent-Typeが含まれています。ブラウザはこの応答を見て「PUTとContent-Typeヘッダは許可されている」と判断し、続けて本来のPUTリクエストを送ります。access-control-allow-headersには、allow_headersに指定したAuthorization / Content-Typeに加えて、Accept / Accept-Language / Content-Language の3つがCORSの安全なヘッダとして自動的に含まれます。access-control-max-age: 600 は「このプリフライト結果を600秒キャッシュしてよい」ことをブラウザに伝えるヘッダで、同じ組み合わせのプリフライトが繰り返される場合の通信コストを抑えます。
コードを解説します。
-H "Origin: http://localhost:5173"
呼び出し元のオリジンをサーバに伝えるヘッダです。ブラウザはクロスオリジンリクエストの際に自動でこれを付けますが、curlでは明示的に指定します。
-H "Access-Control-Request-Method: PUT"
本来これから送るリクエストのHTTPメソッドを、プリフライトの段階でサーバに事前通知します。サーバはこれとallow_methodsを突き合わせて許可可否を判定します。
-H "Access-Control-Request-Headers: Content-Type"
本来これから送るリクエストに含める非単純リクエスト用のヘッダを、プリフライトの段階でサーバに事前通知します。サーバはこれとallow_headersを突き合わせて許可可否を判定します。
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS
access-control-allow-headers: Content-Type, Authorization
サーバが許可するメソッドとヘッダを列挙するレスポンスヘッダです。CORSMiddlewareがallow_methods・allow_headersの値をもとに自動で組み立てます。
vary: Origin
「同じURLでも、Originリクエストヘッダの内容が変わるとレスポンスが変わる」ことをブラウザやプロキシに伝えるヘッダです。CORSレスポンスは呼び出し元のオリジンに応じて変わるため、Varyでキャッシュの取り違えを防ぎます。
2.2 本来のリクエストの送信
プリフライトが通ったあと、ブラウザは本来送りたいリクエストを続けて投げます。この段階もcurlで再現します。書き方は以下のとおりです。
curl -X メソッド -i \
-H "Origin: 呼び出し元のオリジン" \
-H "Content-Type: application/json" \
-d 'JSON文字列' \
URL
上記の書式に沿って、PUT /notes/1にJSONを送ります。
curl -X PUT -i \
-H "Origin: http://localhost:5173" \
-H "Content-Type: application/json" \
-d '{"title":"更新済み"}' \
http://localhost:8000/notes/1
以下のような実行結果が表示されます。
HTTP/1.1 200 OK
access-control-allow-origin: http://localhost:5173
content-type: application/json
content-length: 27
{"id":1,"status":"updated"}
ブラウザ経由の場合、OPTIONS → PUTの2ステップが自動的に行われます。プリフライトが失敗した場合(access-control-allow-methodsに対象メソッドが含まれない、など)は、本来のPUTリクエストは送信すらされずにブロックされる点が、単純リクエストとの違いです。CORSMiddlewareは、allow_methods・allow_headersに含まれる範囲であれば、OPTIONSへの応答を自動で組み立てます。
allow_origins に * を使うことの是非
CORSMiddlewareでは、すべてのオリジンを許可するallow_origins=["*"]という指定も可能ですが、以下の理由から利用には注意が必要です。
- 悪意のある第三者のサイトからも、そのAPIをブラウザ経由で呼び出せる状態になる
- Cookieによる認証(
allow_credentials=True)とallow_origins=["*"]は同時に使えず、ブラウザにブロックされる
原則としては、allow_originsに明示的なオリジンを列挙する運用が安全です。開発時に一時的に緩めたいだけであっても、allow_origins=["*"]はデフォルトの選択肢にはしません。
| 💡 ポイント |
|---|
本章ではallow_originsにオリジンをハードコードしていますが、実際には開発環境・ステージング・本番環境で許可するオリジンが変わります。運用では環境変数や.envファイル(前章 PythonでREST APIを作ろう で扱ったpython-dotenv)からオリジンを読み込み、コードを書き換えずに切り替えられる形にするのが一般的です。 |
| 📝 CORSと認証の関係 |
|---|
CookieやAuthorizationヘッダを伴うクロスオリジンリクエストを許可するには、allow_credentials=Trueと、allow_originsに具体的なオリジンを指定する必要があります(allow_origins=["*"]は同時に使えない)。次章の PythonでJWT認証を実装しよう でAuthorizationヘッダによる認証を扱う際、この組み合わせが前提となります。 |