En-têtes de requête et cookies FastAPI

FastAPI fournitHeaderetCookieType, utilisé pour obtenir des données à partir des en-têtes de requête HTTP et des Cookies.


Paramètre d'en-tête de requête

UtilisationHeaderDéclarez les paramètres d'en-tête de requête :

Exemple

from typing import Annotated
from fastapi import FastAPI, Header

app = FastAPI()


@app.get("/items/")
async def read_items(
    # Recevoir l'en-tête de requête User-Agent
    user_agent: Annotated[str | None, Header()] = None,
):
    return {"User-Agent": user_agent}

Visitezhttp://127.0.0.1:8000/items/Le JSON renvoyé contient les informations User-Agent du navigateur.


Conversion automatique des en-têtes de requête

Les noms de champs dans les en-têtes de requête HTTP utilisent des traits d'union (par ex.,X-Token), tandis que les noms de variables Python ne peuvent pas contenir de traits d'union. FastAPI effectue automatiquement la conversion :

Exemple

from typing import Annotated
from fastapi import FastAPI, Header

app = FastAPI()


@app.get("/items/")
async def read_items(
    # Les noms de variables Python utilisent des traits de soulignement, FastAPI convertit automatiquement en en-tête de requête X-Token
    x_token: Annotated[list[str] | None, Header()] = Aucune,
):
    return {"X-Token values": x_token}

Règles de conversion :

Noms de variables PythonEn-têtes de requête HTTPDescription
x_tokenX-TokenLes traits de soulignement sont automatiquement convertis en tirets
user_agentUser-AgentComme ci-dessus
content_typeContent-TypeComme ci-dessus

FastAPI convertit automatiquement les traits de soulignement dans les noms de variables_Convertir en tirets-pour correspondre aux en-têtes de requête. Si vous devez désactiver cette conversion, définissezHeader(convert_underscores=False)。


Réception d'en-têtes de requête en double

Certains en-têtes de requête peuvent apparaître plusieurs fois (par ex.Set-Cookie), utilisezlistAcceptation de type :

Exemple

from typing import Annotated
from fastapi import FastAPI, Header

app = FastAPI()


@app.get("/items/")
async def read_items(
    # Recevoir plusieurs en-têtes X-Token
    x_token: Annotated[list[str] | None, Header()] = Aucune,
):
    return {"X-Token values": x_token}

Exemple de requête :

GET /items/ HTTP/1.1
X-Token: foo
X-Token: bar

Réponse :{"X-Token values": ["foo", "bar"]}


Paramètres Cookie

UtilisationCookieDéclarer les paramètres Cookie :

Exemple

from typing import Annotated
from fastapi import FastAPI, Cookie

app = FastAPI()


@app.get("/items/")
async def read_items(
    # Recevoir un cookie nommé session_token
    session_token: Annotated[str | None, Cookie()] = None,
):
    return {"session_token": session_token}

Utilisation des en-têtes de requête et des Cookies ensemble

Vous pouvez récupérer à la fois les en-têtes de requête et les Cookies dans la même route :

Exemple

from typing import Annotated
from fastapi import FastAPI, Header, Cookie

app = FastAPI()


@app.get("/items/")
async def read_items(
    user_agent: Annotated[str | None, Header()] = None,
    session_token: Annotated[str | None, Cookie()] = None,
    ads_id: Annotated[str | None, Cookie()] = None,
):
    return {
        "User-Agent": user_agent,
        "Session-Token": session_token,
        "Ads-ID": ads_id,
    }


Résumé

  • UtilisationHeaderObtenir les paramètres d'en-tête de requête HTTP
  • UtilisationCookieObtenir les paramètres de Cookie
  • FastAPI convertit automatiquement les underscores dans les noms de variables Python en tirets dans les en-têtes de requête
  • Utilisationlist[str]Réception d'en-têtes de requête en double
  • Les paramètres d'en-tête de requête et de Cookie prennent en charge les mêmes règles de validation que les paramètres de requête
autres extensions