FastAPI CORS Cross-Origin
CORS (Cross-Origin Resource Sharing) est un mécanisme de sécurité qui autorise ou restreint les demandes de ressources des pages web vers des domaines différents. Lorsque le frontend et le backend sont développés séparément, la page frontend s'exécute généralement sur un domaine ou un port différent, il faut donc configurer CORS pour accéder normalement aux API backend.
Qu'est-ce que le problème cross-origin
La politique de même origine du navigateur empêche les pages web d'envoyer des requêtes vers des domaines différents. Par exemple :
| Adresse du frontend | Adresse de l'API backend | S'agit-il d'un cross-domaine |
|---|---|---|
http://localhost:3000 | http://localhost:8000 | Cross-origin (port différent) |
http://example.com | http://api.example.com | Cross-origin (domaine différent) |
https://example.com | http://example.com | Cross-origin (protocole différent) |
http://example.com | http://example.com/api | Même origine (même domaine, port, protocole) |
Trois éléments de la même origine :Protocole、nom de domaine、port, si l'un d'eux diffère, il s'agit de cross-origin.
Configurer CORS
FastAPI utilise celui de StarletteCORSMiddlewarePour gérer le cross-origin :
Exemple
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# Configurer le middleware CORS
app.add_middleware(
CORSMiddleware,
allow_origins=[ # Origines autorisées (liste de domaines)
"http://localhost:3000", # Serveur de développement frontend
"http://localhost:8080",
],
allow_credentials=True, # Autoriser les cookies
allow_methods=["*"], # Méthodes HTTP autorisées
allow_headers=["*"], # En-têtes de requête autorisés
)
@app.get("/")
async def root():
return {"message": "Hello World"}
Paramètres de configuration CORS expliqués
| Paramètre | Type | Description | valeur recommandée |
|---|---|---|---|
allow_origins | list[str] | Liste des sources cross-origin autorisées | Utiliser des domaines spécifiques en environnement de production |
allow_methods | list[str] | Méthodes HTTP autorisées | ["GET", "POST", "PUT", "DELETE"] |
allow_headers | list[str] | En-têtes de requête autorisés | Configuration à la demande |
allow_credentials | bool | Indique s'il faut autoriser l'envoi de cookies et d'informations d'authentification | À définir lorsque l'authentification est requiseTrue |
expose_headers | list[str] | En-têtes de réponse auxquels le frontend peut accéder | Configuration à la demande |
max_age | int | Durée de mise en cache des requêtes preflight (secondes) | 600 |
allow_originsUtilisation["*"]Indique que toutes les origines sont autorisées, mais cela estallow_credentials=TrueIncompatible. Si vous avez besoin de transporter des cookies, vous devez spécifier une origine spécifique.
Environnement de développement vs environnement de production
Environnement de développement
Pour faciliter le développement, vous pouvez autoriser toutes les origines :
Exemple
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# Environnement de développement : autoriser toutes les origines (pour le développement uniquement !)
app.add_middleware(
CORSMiddleware,
allow_origins=["*"], # Autoriser toutes les origines
allow_credentials=True,
allow_methods=["*"], # Autoriser toutes les méthodes
allow_headers=["*"], # Autoriser tous les en-têtes de requête
)
Environnement de production
L'environnement de production doit spécifier des sources spécifiques :
Exemple
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
# Environnement de production : autoriser uniquement des domaines spécifiques
app.add_middleware(
CORSMiddleware,
allow_origins=[
"https://example.com", # Domaine du frontend de production
"https://www.example.com", # Domaine avec www
],
allow_credentials=True,
allow_methods=["GET", "POST", "PUT", "DELETE"],
allow_headers=["Authorization", "Content-Type"],
max_age=600, # Cache des requêtes préliminaires pendant 10 minutes
)
À utiliser en environnement de production
allow_origins=["*"]Il s'agit d'un risque de sécurité et cela peut entraîner des attaques de falsification de requête intersites (CSRF). Assurez-vous de spécifier le domaine frontend spécifique.
Requête préliminaire CORS
Avant d'envoyer certaines requêtes cross-origin, le navigateur envoie d'abord uneOPTIONSrequête préliminaire, demandant au serveur si la requête réelle est autorisée. Le middleware CORS gère automatiquement les requêtes préliminaires.
Conditions pour les requêtes nécessitant une requête préliminaire :
- utilise
PUT、DELETEMéthodes non simples telles que - L'en-tête de requête contient des champs personnalisés (tels que
Authorization) Content-Typen'est pasapplication/x-www-form-urlencoded、multipart/form-dataoutext/plain
set
max_ageEnsuite, le navigateur met en cache le résultat du preflight et ne renverra pas la requête preflight dans le délai spécifié, ce qui réduit la surcharge réseau.
Résumé
- CORS est un mécanisme de sécurité du navigateur qui doit être configuré dans le développement avec frontend et backend séparés.
- Utilisation
CORSMiddlewareGestion des requêtes inter-origines - En environnement de production, veillez à spécifier le spécifique
allow_origins, n'utilisez pas["*"] allow_credentials=Trueetallow_origins=["*"]incompatible- Le middleware CORS gère automatiquement les requêtes preflight OPTIONS du navigateur.