Validation numérique des paramètres de chemin FastAPI
Utilisation avec les paramètres de requêteQueryLa façon d'ajouter une validation est la même ; vous pouvez utiliserPathDéclarez une validation numérique et des métadonnées pour les paramètres de chemin.
Importer Path
fromfastapiImporterPath, fromtypingImporterAnnotated:
Exemple
from fastapi import FastAPI, Path
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
# Ajouter des métadonnées et une validation pour les paramètres de chemin
item_id: Annotated[int, Path(title="Product ID", description="Product ID to fetch", ge=1)],
):
return {"item_id": item_id}
Les paramètres de chemin sont toujours obligatoires car ils doivent faire partie du chemin de l’URL. Même si vous déclarez une valeur par défaut pour eux, ils sont toujours traités comme des paramètres obligatoires.
Validation numérique
PathetQueryTous prennent en charge les paramètres de validation numérique suivants :
| Paramètre | Signification | Source anglaise |
|---|---|---|
gt | supérieur à | gSupérieur tà |
ge | supérieur ou égal à | gSupérieur ou eégal à |
lt | inférieur à | lInférieur tà |
le | inférieur ou égal à | lInférieur ou eégal à |
Supérieur ou égal à (ge)
Limiteitem_idDoit être >= 1 :
Exemple
from fastapi import FastAPI, Path
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
item_id: Annotated[int, Path(ge=1)], # item_id doit être >= 1
):
return {"item_id": item_id}
Combiner la validation numérique
Exemple
from fastapi import FastAPI, Path, Query
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
# item_id doit être > 0 et <= 1000
item_id: Annotated[int, Path(gt=0, le=1000)],
# Les paramètres de requête peuvent aussi utiliser la validation numérique
size: Annotated[float, Query(gt=0, lt=10.5)] = 5.0,
):
return {"item_id": item_id, "size": size}
Validation des nombres à virgule flottante
La validation numérique s'applique également aux nombres à virgule flottante.gt(supérieur à) etgeLa différence (supérieure ou égale à) est importante dans les scénarios en virgule flottante :
Exemple
from fastapi import FastAPI, Path, Query
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
item_id: Annotated[int, Path(ge=1, le=1000)],
# size doit être > 0 et < 10.5
# 0.5 est une valeur valide, 0.0 et 0 ne le sont pas (car gt=0 est strictement supérieur à 0)
size: Annotated[float, Query(gt=0, lt=10.5)],
):
return {"item_id": item_id, "size": size}
Mélanger des paramètres de chemin et des paramètres de requête
Lorsque vous utilisez les deuxPathetQuerylors de l'utilisationAnnotatedCela peut éviter les problèmes d'ordre des paramètres :
Exemple
from fastapi import FastAPI, Path, Query
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
# Après avoir utilisé Annotated, l'ordre des paramètres n'a pas d'importance
item_id: Annotated[int, Path(title="Product ID", ge=1, le=1000)],
q: Annotated[str | None, Query(max_length=50)] = None,
):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
Résumé
Points clés de la validation numérique pour les paramètres de chemin :
- Utilisation
Annotated+PathDéclaration des règles de validation pour les paramètres de chemin - Validation numérique :
gt(supérieur à),ge(supérieur ou égal à),lt(inférieur à),le(inférieur ou égal à) PathetQueryPartageant les mêmes paramètres de validation, y compris la validation de chaîne (min_lengthetc.) et les métadonnées (title、descriptionetc.)- Les paramètres de chemin sont toujours obligatoires, qu'une valeur par défaut soit déclarée ou non.