Données de formulaire FastAPI

Lorsqu'un client envoie des données via un formulaire HTML (application/x-www-form-urlencoded) Lors de la soumission de données, vous devez utiliserFormpour recevoir les champs de formulaire, au lieu deBaseModel。


Installez python-multipart

Avant d'utiliser les fonctionnalités de formulaire, vous devez installerpython-multipart:

pip install python-multipart

Réception des données de formulaire

UtilisationFormDéclaration des champs de formulaire

Exemple

from fastapi import FastAPI, Form

app = FastAPI()


@app.post("/login/")
async def login(
    username: str = Form(),      # Champs de formulaire requis
    password: str = Form(),      # Champs de formulaire requis
):
    return {"username": username}


Différence entre les champs de formulaire et le corps de la requête JSON

Élément de comparaisonCorps de la requête JSONDonnées de formulaire
Content-Typeapplication/jsonapplication/x-www-form-urlencoded
Méthode de déclarationPydantic BaseModelForm()
Structures de donnéesPrend en charge les objets et tableaux imbriquésPaires clé-valeur à plat
Scénarios applicablesInterface API (séparation front-end / back-end)Soumission de formulaire HTML

Les données de formulaire sont envoyées sous forme de "champs", et non de JSON. Par conséquent, vous ne pouvez pasFormdéclarer des paramètres comme modèles Pydantic. Les champs de formulaire et le corps de requête JSON ne peuvent pas être utilisés ensemble dans la même route.


Champs de formulaire facultatifs

Comme pour les paramètres de requête, les champs de formulaire avec des valeurs par défaut sont facultatifs :

Exemple

from fastapi import FastAPI, Form

app = FastAPI()


@app.post("/items/")
async def create_item(
    name: str = Form(...),                    # Obligatoire
    description: str | None = Form(None),     # Facultatif, valeur par défaut None
    price: float = Form(..., gt=0),           # Obligatoire, doit être supérieur à 0
):
    return {"name": name, "description": description, "price": price}


Tester avec des formulaires HTML

Vous pouvez créer une page HTML pour tester la soumission d'un formulaire :

Exemple

<form action="http://localhost:8000/items/" method="post">
    <label for="name">Nom :</label>
    <input type="text" id="name" name="name" required>
    <br>
    <label for="description">Description :</label>
    <textarea id="description" name="description"></textarea>
    <br>
    <label for="price">Prix :</label>
    <input type="number" id="price" name="price" required min="0">
    <br>
    <button type="submit">Envoyer</button>
</forme>

Validation et documentation des données du formulaire

UtilisationFormPour les champs déclarés, FastAPI effectuera automatiquement la validation des données et les affichera dans la documentation de l'API :


Résumé

  • UtilisationFormRéception de données soumises à partir d'un formulaire HTML
  • Les données de formulaire ne sont pas du JSON et ne peuvent pas être utilisées avecBaseModelMélange de corps de requête
  • Form()Déclaration de champs obligatoiresForm(None)Déclaration de champs facultatifs
  • Nécessite une installationpython-multipartPaquet
  • Les champs de formulaire prennent en charge les mêmes règles de validation que les paramètres de requête (min_length、gtetc.)
autres extensions