FastAPI-Anfragen und -Antworten

In FastAPI sind Request und Response der Kern der Interaktion mit Clients.

FastAPI bietet leistungsstarke Werkzeuge, um Anfragedaten zu parsen und bei Bedarf standardisierte Antworten zu generieren.

Als Nächstes werfen wir einen detaillierten Blick auf die Requests und Responses von FastAPI.

Für HTTP-bezogene Inhalte siehe:HTTP-Anfragemethoden。

Request-Daten

Query-Parameter

Im folgenden Beispiel definieren wir eine/items/Route, die zwei Query-Parameter akzeptiertskipundlimit, ihre Typen sind beide Integer, mit Standardwerten jeweils0und10。

Beispiel

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
def read_item(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

Führen Sie den folgenden Befehl in der Befehlszeile aus, um die Anwendung zu starten:

uvicorn main:app --reload

Öffnen Sie nun Ihren Browser und besuchen Siehttp://127.0.0.1:8000/items/, was die Standard-JSON-Daten zurückgibt:

Übergeben SieGET-Anfrageparameter an diehttp://127.0.0.1:8000/items/?skip=1&limit=5, es werden JSON-Daten wie folgt zurückgegeben:

Pfadparameter

Wir können Parameter im Pfad festlegen, wodurch die URL ästhetisch ansprechender wirkt.

Im folgenden Beispiel definieren wir einen Pfadparameteritem_idund Abfrageparameterqroute.

Beispiel

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

Übergeben SieGET-Anfrageparameter an diehttp://127.0.0.1:8000/items/5/?q=example, es werden JSON-Daten wie folgt zurückgegeben:

Request-Body

Als Nächstes haben wir eine/items/-Route erstellt, wobei der@app.post-Decorator anzeigt, dass diesPOSTAnfrage-Route.

Beispiel

from pydantic import BaseModel
from fastapi import FastAPI

app = FastAPI()
class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
def create_item(item: Item):
    return item

Verwende das Pydantic-Modell Item, um einen Request-Body zu definieren, der mehrere Felder enthält, von denen einige Standardwerte haben. Für eine ausführlichere Einführung in Pydantic siehe:FastAPI Pydantic-Modell。

Als Nächstes können wirhttp://127.0.0.1:8000/docsöffnen, um einen POST-Test durchzuführen:

Füllen Sie die Request-Parameter aus:

Das zurückgegebene Ergebnis sieht wie folgt aus:


Antwortdaten

JSON-Daten zurückgeben

Die Route-Handler-Funktion gibt ein Dictionary zurück, das FastAPI automatisch in das JSON-Format konvertiert und als Antwort an den Client sendet:

Beispiel

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
def read_item(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

Wenn der obige Code im Browser unterhttp://127.0.0.1:8000/items/aufgerufen wird, werden JSON-Daten zurückgegeben:

Pydantic-Modell zurückgeben

Die Route-Handler-Funktion gibt eine Pydantic-Modellinstanz zurück. FastAPI konvertiert sie automatisch in das JSON-Format und sendet sie als Antwort an den Client:

Beispiel

from pydantic import BaseModel
from fastapi import FastAPI

app = FastAPI()
class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
def create_item(item: Item):
    return item

POST-Anfrage, das zurückgegebene Datenformat sieht wie folgt aus:

{
  "name": "example",
  "description": "Example POST 测试",
  "price": 12,
  "tax": 1
}

Anfrage-Header und Cookies

Verwenden Sie Header- und Cookie-Typannotationen, um Anfrage-Header- und Cookie-Daten zu erhalten.

Beispiel

from fastapi import Header, Cookie
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
def read_item(user_agent: str = Header(None), session_token: str = Cookie(None)):
    return {"User-Agent": user_agent, "Session-Token": session_token}

Wenn der obige Code im Browser unterhttp://127.0.0.1:8000/items/aufgerufen wird, werden JSON-Daten zurückgegeben:


Weiterleitungen und Statuscodes

VerwendungRedirectResponseImplementieren Sie eine Weiterleitung, die den Client zur/items/Route weiterleitet.

Beispiel

from fastapi import Header, Cookie
from fastapi import FastAPI
from fastapi.responses import RedirectResponse

app = FastAPI()

@app.get("/items/")
def read_item(user_agent: str = Header(None), session_token: str = Cookie(None)):
    return {"User-Agent": user_agent, "Session-Token": session_token}

@app.get("/redirect")
def redirect():
    return RedirectResponse(url="/items/")

Wenn der obige Code im Browser aufgerufen wird,http://127.0.0.1:8000/redirect/wird automatisch zurhttp://127.0.0.1:8000/items/Seite weitergeleitet:

Verwenden Sie HTTPException, um Ausnahmen auszulösen und benutzerdefinierte Statuscodes sowie detaillierte Informationen zurückzugeben.

Die folgenden Beispiele sind initem_idist42wird zurückgeben404Statuscode:

Beispiel

from fastapi import HTTPException

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    if item_id == 42:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}

Wenn der obige Code im Browser aufgerufen wirdhttp://127.0.0.1:8000/items/42/Die Seite wird wie folgt angezeigt:


Benutzerdefinierte Response-Header

VerwendungJSONResponseBenutzerdefinierte Response-Header:

Beispiel

from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    content = {"item_id": item_id}
    headers = {"X-Custom-Header": "custom-header-value"}
    return JSONResponse(content=content, headers=headers)

Wenn der obige Code im Browser aufgerufen wirdhttp://127.0.0.1:8000/items/42/Die Seite wird wie folgt angezeigt, wobei wir unsere benutzerdefinierten Response-Header sehen können:

Weitere Erweiterungen