FastAPI 0.115 est sorti
par Makersquad ·
Date de sortie : 17 septembre 2024
Release officielle : FastAPI 0.115.0
La release du 17 septembre 2024. FastAPI permet désormais d’utiliser des modèles Pydantic pour Query, Header et Cookie, un manque historique du framework quand on avait beaucoup de paramètres à valider ensemble. Le détail figure dans la release officielle FastAPI 0.115.0 (s’ouvre dans un nouvel onglet).
Les nouveautés principales
Modèles Pydantic pour Query
Plus besoin de lister chaque paramètre de query string à la main, ni de passer par un bricolage :
from typing import Annotated
from fastapi import FastAPI, Query
from pydantic import BaseModel
app = FastAPI()
class FilterParams(BaseModel):
limit: int = 100
offset: int = 0
order_by: str = "created_at"
@app.get("/items/")
async def list_items(filters: Annotated[FilterParams, Query()]):
return filters
La documentation OpenAPI générée liste chaque champ du modèle comme un paramètre de query distinct, avec validation.
Modèles pour Header et Cookie
Même principe pour les headers et les cookies :
from fastapi import Header
class CommonHeaders(BaseModel):
user_agent: str
accept_language: str | None = None
x_request_id: str | None = None
@app.get("/items/")
async def list_items(headers: Annotated[CommonHeaders, Header()]):
return headers
Pratique pour factoriser les headers communs à plusieurs endpoints.
Interdire les paramètres supplémentaires
Avec model_config = {"extra": "forbid"} sur le modèle Pydantic, FastAPI rejette les requêtes qui envoient des paramètres non déclarés :
class StrictFilters(BaseModel):
model_config = {"extra": "forbid"}
limit: int = 100
offset: int = 0
# GET /items/?limit=10&tool=plumbus
# → 422 Unprocessable Entity
Le client reçoit une erreur qui nomme le paramètre refusé, dans ce format de la documentation officielle :
{
"detail": [
{
"type": "extra_forbidden",
"loc": ["query", "tool"],
"msg": "Extra inputs are not permitted",
"input": "plumbus"
}
]
}
Utile pour les APIs publiques où on veut détecter les typos côté client au lieu de les ignorer silencieusement.
À retenir
Un ajout attendu depuis longtemps. Si vous aviez des endpoints avec beaucoup de paramètres de query, la lisibilité s’améliore nettement. Combiné à extra: forbid, c’est aussi un outil pour durcir la validation des entrées sans effort.