Routage de base FastAPI

Dans FastAPI, le routage de base est essentiel pour définir les points de terminaison d'API.

Chaque route correspond à une fonction de l'application qui traite une requête HTTP spécifique et renvoie la réponse correspondante.

Route de chemin racine

Créer une instance FastAPI et le routage de chemin racine :

Exemple

from fastapi import FastAPI

app = FastAPI()

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

Explication du code :

  • FastAPI(): Créez une instance d'application FastAPI.
  • @app.get("/"): Utiliser@app.getLe décorateur crée une route qui gère le chemin racine.
  • def read_root(): La fonction de gestion de route renvoie un dictionnaire contenant {"Hello": "World"}.

Paramètre de chemin

Définir les paramètres de route :

Exemple

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}

Explication du code :

  • @app.get("/items/{item_id}"): Définit un chemin de route, où{item_id}est le paramètre de chemin, correspondant au paramètre de la fonctionitem_id。
  • def read_item(item_id: int, q: str = None): La fonction de gestion de route accepte un paramètre de chemin entieritem_idet un paramètre de requête de type chaîne facultatifq。

Dans les opérations de route, les paramètres de requête peuvent être déclarés à l'aide des paramètres de fonction. Par exemple,q: str = NoneReprésenteqest un paramètre de requête de type chaîne facultatif avec une valeur par défaut deNone。

Démarrez l'application et testez les routes

Démarrez l'application avec Uvicorn :

uvicorn main:app --reload

Visitezhttp://127.0.0.1:8000Affichez la réponse du chemin racine :

Visitez http://127.0.0.1:8000/items/42?q=example pour voir la réponse avec les paramètres de chemin et les paramètres de requête :

La documentation API interactive générée automatiquement par FastAPI inclura les informations de route définies, les paramètres de chemin, les paramètres de requête, etc. Visitez l'URL de la documentation.http://127.0.0.1:8000/docsAffichez la documentation détaillée et l'interface de test :

autres extensions