Requêtes et réponses FastAPI

Dans FastAPI, la requête et la réponse sont au cœur de l'interaction avec les clients.

FastAPI fournit des outils puissants pour analyser les données de requête et générer des réponses standardisées selon les besoins.

Ensuite, examinons en détail les requêtes et les réponses de FastAPI.

Pour le contenu lié à HTTP, veuillez consulter :Méthodes de requête HTTP。

Données de requête

Paramètre de requête

Dans l'exemple suivant, nous définissons une/items/route qui accepte deux paramètres de requêteskipetlimit, leurs types sont tous deux des entiers, avec des valeurs par défaut respectives0et10。

Exemple

from fastapi import FastAPI

app = FastAPI()

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

Exécutez la commande suivante dans la ligne de commande pour démarrer l'application :

uvicorn main:app --reload

Maintenant, ouvrez votre navigateur et visitezhttp://127.0.0.1:8000/items/, renvoie les données JSON par défaut :

PassezGETParamètres de requêtehttp://127.0.0.1:8000/items/?skip=1&limit=5, renvoie les données JSON comme suit :

Paramètre de chemin

Nous pouvons définir des paramètres sur le chemin, ce qui rend l'URL plus esthétique.

Dans l'exemple suivant, nous définissons un paramètre de cheminitem_idet des paramètres de requêteqroute.

Exemple

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}

PassezGETParamètres de requêtehttp://127.0.0.1:8000/items/5/?q=example, renvoie les données JSON comme suit :

corps de requête

Ensuite, nous avons créé une/items/route, en utilisant@app.postLe décorateur indique que cela gèrePOSTroute de la requête.

Exemple

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

Utilisez le modèle Pydantic Item pour définir un corps de requête, contenant plusieurs champs, dont certains ont des valeurs par défaut. Pour plus d'introduction à Pydantic, reportez-vous à :Modèle Pydantic de FastAPI。

Ensuite, nous pouvons ouvrirhttp://127.0.0.1:8000/docspour effectuer un test POST :

Remplissez les paramètres de requête :

Le résultat renvoyé est le suivant :


Données de réponse

Renvoyer des données JSON

La fonction gestionnaire de route renvoie un dictionnaire, que FastAPI convertira automatiquement au format JSON et enverra au client comme réponse :

Exemple

from fastapi import FastAPI

app = FastAPI()

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

Lorsque le code ci-dessus est accédé dans le navigateurhttp://127.0.0.1:8000/items/, il renvoie des données JSON :

Renvoyer un modèle Pydantic

La fonction gestionnaire de route renvoie une instance de modèle Pydantic. FastAPI la convertira automatiquement au format JSON et l'enverra au client comme réponse :

Exemple

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

Requête POST, le format des données renvoyées est le suivant :

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

En-têtes de requête et cookies

Utilisez les annotations de type Header et Cookie pour obtenir les données d'en-tête et de cookie de la requête.

Exemple

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}

Lorsque le code ci-dessus est accédé dans le navigateurhttp://127.0.0.1:8000/items/, il renvoie des données JSON :


Redirections et codes d'état

UtilisationRedirectResponseImplémentez une redirection, redirigeant le client vers/items/route.

Exemple

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/")

Lorsque le code ci-dessus est consulté dans le navigateurhttp://127.0.0.1:8000/redirect/redirigera automatiquement vershttp://127.0.0.1:8000/items/page :

Utilisez HTTPException pour lever des exceptions et renvoyer des codes d'état personnalisés et des informations détaillées.

Les exemples suivants sont dansitem_idest42renverra404Code d'état :

Exemple

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}

Lorsque le code ci-dessus est accédé dans le navigateurhttp://127.0.0.1:8000/items/42/La page s'affiche comme suit :


En-têtes de réponse personnalisés

UtilisationJSONResponseEn-têtes de réponse personnalisés :

Exemple

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)

Lorsque le code ci-dessus est accédé dans le navigateurhttp://127.0.0.1:8000/items/42/La page s'affiche comme suit, où nous pouvons voir nos en-têtes de réponse personnalisés :

autres extensions