FastAPI CORS Cross-Origin
CORS (Cross-Origin Resource Sharing) ist ein Sicherheitsmechanismus, der es Webseiten erlaubt oder verbietet, Ressourcen von anderen Domains anzufordern. Wenn Frontend und Backend getrennt entwickelt werden, läuft die Frontend-Seite normalerweise auf einer anderen Domain oder einem anderen Port, daher muss CORS konfiguriert werden, um ordnungsgemäß auf Backend-APIs zugreifen zu können.
Was ist das Cross-Origin-Problem
Die Same-Origin-Policy des Browsers schränkt Webseiten darin ein, Anfragen an andere Domains zu senden. Zum Beispiel:
| Frontend-Adresse | Backend-API-Adresse | Ob Cross-Domain |
|---|---|---|
http://localhost:3000 | http://localhost:8000 | Cross-Origin (anderer Port) |
http://example.com | http://api.example.com | Cross-Origin (andere Domain) |
https://example.com | http://example.com | Cross-Origin (anderes Protokoll) |
http://example.com | http://example.com/api | Same-Origin (gleiche Domain, gleicher Port, gleiches Protokoll) |
Drei Bestandteile von Same-Origin:Protokoll、Domainname、Port, wenn eines davon abweicht, handelt es sich um Cross-Origin.
CORS konfigurieren
FastAPI verwendet StarlettesCORSMiddlewareUm Cross-Origin zu behandeln:
Beispiel
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# CORS-Middleware konfigurieren
app.add_middleware(
CORSMiddleware,
allow_origins=[ # Erlaubte Origins (Domainliste)
"http://localhost:3000", # Frontend-Entwicklungsserver
"http://localhost:8080",
],
allow_credentials=True, # Cookies erlauben
allow_methods=["*"], # Erlaubte HTTP-Methoden
allow_headers=["*"], # Erlaubte Anfrage-Header
)
@app.get("/")
async def root():
return {"message": "Hello World"}
CORS-Konfigurationsparameter erklärt
| Parameter | Type | Beschreibung | empfohlener Wert |
|---|---|---|---|
allow_origins | list[str] | Liste der erlaubten Cross-Origin-Quellen | Konkrete Domains in der Produktionsumgebung verwenden |
allow_methods | list[str] | Erlaubte HTTP-Methoden | ["GET", "POST", "PUT", "DELETE"] |
allow_headers | list[str] | Erlaubte Anfrage-Header | Bedarfsgesteuerte Konfiguration |
allow_credentials | bool | Ob das Mitführen von Cookies und Authentifizierungsinformationen erlaubt werden soll | Wird gesetzt, wenn Authentifizierung erforderlich istTrue |
expose_headers | list[str] | Response-Header, auf die das Frontend zugreifen kann | Bedarfsgesteuerte Konfiguration |
max_age | int | Cache-Dauer von Preflight-Anfragen (Sekunden) | 600 |
allow_originsNutzung["*"]Gibt an, dass alle Origins erlaubt sind, aber dies istallow_credentials=TrueInkompatibel. Wenn Sie Cookies senden müssen, müssen Sie einen bestimmten Origin angeben.
Entwicklungsumgebung vs. Produktionsumgebung
Entwicklungsumgebung
Der Einfachheit halber können Sie während der Entwicklung alle Origins zulassen:
Beispiel
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# Entwicklungsumgebung: alle Origins zulassen (nur für die Entwicklung!)
app.add_middleware(
CORSMiddleware,
allow_origins=["*"], # Alle Origins zulassen
allow_credentials=True,
allow_methods=["*"], # Alle Methoden zulassen
allow_headers=["*"], # Alle Anfrage-Header zulassen
)
Produktionsumgebung
In der Produktionsumgebung müssen bestimmte Quellen angegeben werden:
Beispiel
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# Produktionsumgebung: nur bestimmte Domains zulassen
app.add_middleware(
CORSMiddleware,
allow_origins=[
"https://example.com", # Produktions-Frontend-Domain
"https://www.example.com", # Domain mit www
],
allow_credentials=True,
allow_methods=["GET", "POST", "PUT", "DELETE"],
allow_headers=["Authorization", "Content-Type"],
max_age=600, # Preflight-Request-Cache für 10 Minuten
)
In der Produktionsumgebung verwenden
allow_origins=["*"]Dies ist ein Sicherheitsrisiko und kann zu Cross-Site-Request-Forgery-(CSRF)-Angriffen führen. Geben Sie unbedingt die spezifische Frontend-Domain an.
CORS-Preflight-Anfrage
Bevor der Browser bestimmte Cross-Origin-Anfragen sendet, sendet er zunächst eineOPTIONSPreflight-Anfrage, um den Server zu fragen, ob die eigentliche Anfrage erlaubt ist. Die CORS-Middleware verarbeitet Preflight-Anfragen automatisch.
Bedingungen für Anfragen, die ein Preflight erfordern:
- verwendet
PUT、DELETENicht-einfache Methoden wie - Der Request-Header enthält benutzerdefinierte Felder (wie z. B.
Authorization) Content-Typeist nichtapplication/x-www-form-urlencoded、multipart/form-dataodertext/plain
set
max_ageDanach speichert der Browser das Preflight-Ergebnis im Cache und sendet die Preflight-Anfrage innerhalb der angegebenen Zeit nicht erneut, wodurch der Netzwerk-Overhead reduziert wird.
Zusammenfassung
- CORS ist ein Sicherheitsmechanismus des Browsers, der bei der getrennten Entwicklung von Frontend und Backend konfiguriert werden muss.
- Nutzung
CORSMiddlewareUmgang mit Cross-Origin-Anfragen - In der Produktionsumgebung unbedingt die spezifische angeben
allow_origins, verwenden Sie nicht["*"] allow_credentials=Trueundallow_origins=["*"]inkompatibel- Die CORS-Middleware verarbeitet automatisch die OPTIONS-Preflight-Anfragen des Browsers.