fastapi/docs/ja/docs/tutorial/cors.md at c6987ceabb3b46f09a99d112141178576a9b5f52

7.1 KiB

Raw Blame History

CORSまたは「Cross-Origin Resource Sharing」は、ブラウザで実行されているフロントエンドにバックエンドと通信するJavaScriptコードがあり、そのバックエンドがフロントエンドとは異なる「オリジン」にある状況を指します。

オリジン

オリジンはプロトコル (http、https) とドメイン (myapp.com、localhost、localhost.tiangolo.com) とポート (80、443、8080) の組み合わせです。

したがって、以下はすべて異なるオリジンです:

http://localhost
https://localhost
http://localhost:8080

すべて localhost であっても、異なるプロトコルやポートを使用するので、異なる「オリジン」です。

ステップ

そして、ブラウザ上で実行されているフロントエンド (http://localhost:8080) があり、そのJavaScriptが http://localhost で実行されているバックエンドと通信するとします。(ポートを指定していないので、ブラウザはデフォルトの80ポートを使用します)

次に、ブラウザはHTTPの OPTIONS リクエストを :80 のバックエンドに送信します。そして、バックエンドがこの異なるオリジン (http://localhost:8080) からの通信を許可する適切なヘッダーを送信すると、:8080 のブラウザはフロントエンドのJavaScriptに :80 のバックエンドへのリクエストを送信させます。

これを実現するには、:80 のバックエンドに「許可されたオリジン」のリストがなければなりません。

この場合、:8080 のフロントエンドを正しく機能させるには、そのリストに http://localhost:8080 を含める必要があります。

ワイルドカード

リストを "*" (「ワイルドカード」) と宣言して、すべてを許可することもできます。

ただし、クレデンシャル情報に関するもの、つまりCookie、Bearer Tokenで使用されるようなAuthorizationヘッダーなどを含むものは除外され、特定の種類の通信のみが許可されます。

したがって、すべてを正しく機能させるために、許可されたオリジンの明示的な指定をお勧めします。

`CORSMiddleware` の使用

FastAPI アプリケーションでは CORSMiddleware を使用して、CORSに関する設定ができます。

CORSMiddlewareをインポートします。
許可されたオリジンのリストを (文字列として) 作成します。
これを「ミドルウェア」として FastAPI アプリケーションに追加します。

以下も、バックエンドに許可させるかどうか指定できます:

クレデンシャル情報 (Authorizationヘッダー、Cookieなど) 。
特定のHTTPメソッド (POST、PUT) またはワイルドカード "*" を使用してすべて許可。
特定のHTTPヘッダー、またはワイルドカード "*"を使用してすべて許可。

{* ../../docs_src/cors/tutorial001_py39.py hl[2,6:11,13:19] *}

CORSMiddleware 実装で使用されるデフォルトのパラメータはデフォルトで制限が厳しいため、ブラウザがクロスドメインのコンテキストでそれらを使用できるようにするには、特定のオリジン、メソッド、またはヘッダーを明示的に有効にする必要があります。

以下の引数がサポートされています:

allow_origins - オリジン間リクエストを許可するオリジンのリスト。例えば、['https://example.org', 'https://www.example.org']。['*']を使用して任意のオリジンを許可できます。
allow_origin_regex - オリジン間リクエストを許可するオリジンの正規表現文字列。例えば、'https://.*\.example\.org'。
allow_methods - オリジン間リクエストで許可するHTTPメソッドのリスト。デフォルトは ['GET'] です。['*']を使用してすべての標準メソッドを許可できます。
allow_headers - オリジン間リクエストでサポートするHTTPリクエストヘッダーのリスト。デフォルトは [] です。['*']を使用して、すべてのヘッダーを許可できます。シンプルなCORSリクエストでは、 Accept 、 Accept-Language 、 Content-Language 、 Content-Type ヘッダーが常に許可されます。
allow_credentials - オリジン間リクエストでCookieをサポートする必要があることを示します。デフォルトは False です。

allow_credentials が True に設定されている場合、allow_origins、allow_methods、allow_headers のいずれも ['*'] に設定できません。これらはすべて明示的に指定する必要があります。
expose_headers - ブラウザからアクセスできるようにするレスポンスヘッダーを示します。デフォルトは [] です。
max_age - ブラウザがCORSレスポンスをキャッシュする最大時間を秒単位で設定します。デフォルトは 600 です。

このミドルウェアは2種類のHTTPリクエストに応答します...

CORSプリフライトリクエスト

これらは、 Origin ヘッダーと Access-Control-Request-Method ヘッダーを持つ OPTIONS リクエストです。

この場合、ミドルウェアはリクエストを横取りし、適切なCORSヘッダーと共に情報提供のために 200 または 400 のレスポンスを返します。

シンプルなリクエスト

Origin ヘッダーのあるリクエスト。この場合、ミドルウェアは通常どおりリクエストに何もしないですが、レスポンスに適切なCORSヘッダーを加えます。

より詳しい情報

CORSについてより詳しい情報は、Mozilla CORS documentation を参照して下さい。

/// note | 技術詳細

from starlette.middleware.cors import CORSMiddleware も使用できます。

FastAPI は、開発者の利便性を高めるために、fastapi.middleware でいくつかのミドルウェアを提供します。利用可能なミドルウェアのほとんどは、Starletteから直接提供されています。

///

7.1 KiB Raw Blame History

CORS (Cross-Origin Resource Sharing)