FastAPI-Request-Header und Cookies

FastAPI bietetHeaderundCookieTyp, der verwendet wird, um Daten aus HTTP-Request-Headern und Cookies abzurufen.


Request-Header-Parameter

NutzungHeaderAnfrage-Header-Parameter deklarieren:

Beispiel

from typing import Annotated
from fastapi import FastAPI, Header

app = FastAPI()


@app.get("/items/")
async def read_items(
    # User-Agent-Anfrage-Header empfangen
    user_agent: Annotated[str | None, Header()] = None,
):
    return {"User-Agent": user_agent}

Besuchen Siehttp://127.0.0.1:8000/items/Das zurückgegebene JSON enthält die User-Agent-Informationen des Browsers.


Automatische Konvertierung von Anfrage-Headern

Feldnamen in HTTP-Anfrage-Headern verwenden Bindestriche (z. B.,X-Token), während Python-Variablennamen keine Bindestriche enthalten dürfen. FastAPI führt die Konvertierung automatisch durch:

Beispiel

from typing import Annotated
from fastapi import FastAPI, Header

app = FastAPI()


@app.get("/items/")
async def read_items(
    # Python-Variablennamen verwenden Unterstriche, FastAPI konvertiert automatisch in den X-Token-Anfrage-Header
    x_token: Annotated[list[str] | None, Header()] = Keine,
):
    return {"X-Token values": x_token}

Konvertierungsregeln:

Python-VariablennamenHTTP-Anfrage-HeaderBeschreibung
x_tokenX-TokenUnterstriche werden automatisch in Bindestriche umgewandelt
user_agentUser-AgentWie oben
content_typeContent-TypeWie oben

FastAPI wandelt Unterstriche in Variablennamen automatisch um_In Bindestriche umwandeln-um sie an Anfrage-Header anzupassen. Wenn Sie diese Konvertierung deaktivieren möchten, setzen SieHeader(convert_underscores=False)。


Doppelte Anfrage-Header empfangen

Einige Anfrage-Header können mehrfach auftreten (z. B.Set-Cookie), verwenden SielistTypakzeptanz:

Beispiel

from typing import Annotated
from fastapi import FastAPI, Header

app = FastAPI()


@app.get("/items/")
async def read_items(
    # Mehrere X-Token-Header empfangen
    x_token: Annotated[list[str] | None, Header()] = Keine,
):
    return {"X-Token values": x_token}

Anfragebeispiel:

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

Antwort:{"X-Token values": ["foo", "bar"]}


Cookie-Parameter

NutzungCookieCookie-Parameter deklarieren:

Beispiel

from typing import Annotated
from fastapi import FastAPI, Cookie

app = FastAPI()


@app.get("/items/")
async def read_items(
    # Empfange ein Cookie namens session_token
    session_token: Annotated[str | None, Cookie()] = None,
):
    return {"session_token": session_token}

Request-Header und Cookies zusammen verwenden

Du kannst sowohl Request-Header als auch Cookies in derselben Route abrufen:

Beispiel

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,
    }


Zusammenfassung

  • NutzungHeaderHTTP-Request-Header-Parameter abrufen
  • NutzungCookieCookie-Parameter abrufen
  • FastAPI wandelt Unterstriche in Python-Variablennamen automatisch in Bindestriche in Request-Headern um.
  • Nutzunglist[str]Doppelte Anfrage-Header empfangen
  • Request-Header- und Cookie-Parameter unterstützen dieselben Validierungsregeln wie Query-Parameter.
Weitere Erweiterungen