FastAPI Basis-Routing

In FastAPI ist das Basisrouting entscheidend für die Definition von API-Endpunkten.

Jede Route ist einer Funktion in der Anwendung zugeordnet, die eine bestimmte HTTP-Anfrage verarbeitet und die entsprechende Antwort zurückgibt.

Stammpfad-Route

FastAPI-Instanz erstellen und Stammpfad-Routing:

Beispiel

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

Code-Erklärung:

  • FastAPI(): Eine FastAPI-Anwendungsinstanz erstellen.
  • @app.get("/"): Verwenden@app.getDer Decorator erstellt eine Route, die den Root-Pfad verarbeitet.
  • def read_root(): Die Route-Handler-Funktion gibt ein Dictionary zurück, das {"Hello": "World"} enthält.

Pfadparameter

Routenparameter festlegen:

Beispiel

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

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

Code-Erklärung:

  • @app.get("/items/{item_id}"): Definiert einen Routenpfad, wobei{item_id}ist der Pfadparameter, der dem Funktionsparameter entsprichtitem_id。
  • def read_item(item_id: int, q: str = None): Die Route-Handler-Funktion akzeptiert einen ganzzahligen Pfadparameteritem_idund einen optionalen String-Query-Parameterq。

In Routenoperationen können Query-Parameter mithilfe von Funktionsparametern deklariert werden. Zum Beispiel,q: str = Nonebedeutet, dassqein optionaler String-Query-Parameter mit einem Standardwert vonNone ist。

Anwendung starten und Routen testen

Starten Sie die Anwendung mit Uvicorn:

uvicorn main:app --reload

Besuchen Siehttp://127.0.0.1:8000Sehen Sie sich die Antwort des Root-Pfads an:

Besuchen Sie http://127.0.0.1:8000/items/42?q=example, um die Antwort mit Pfadparametern und Abfrageparametern zu sehen:

Die interaktive API-Dokumentation, die automatisch von FastAPI generiert wird, enthält definierte Routeninformationen, Pfadparameter, Abfrageparameter usw. Besuchen Sie die Dokumentations-URL.http://127.0.0.1:8000/docsSehen Sie sich die detaillierte Dokumentation und die Testoberfläche an:

Weitere Erweiterungen