Form Models (Modelos de Formulario)¶

Puedes usar modelos de Pydantic para declarar campos de formulario en FastAPI.

Nota

Para usar formularios, primero instala python-multipart.

Asegúrate de crear un entorno virtual, activarlo, y luego instalarlo, por ejemplo:


$ pip install python-multipart

Nota

Esto está soportado desde la versión 0.113.0 de FastAPI. 🤓

Modelos de Pydantic para Formularios¶

Solo necesitas declarar un modelo de Pydantic con los campos que quieres recibir como campos de formulario, y luego declarar el parámetro como Form:

Python 3.10+


from typing import Annotated

from fastapi import FastAPI, Form
from pydantic import BaseModel

app = FastAPI()


class FormData(BaseModel):
    username: str
    password: str


@app.post("/login/")
async def login(data: Annotated[FormData, Form()]):
    return data

🤓 Otras versiones y variantes

Python 3.10+ - non-Annotated

Consejo

Preferible usar la versión con Annotated si es posible.


from fastapi import FastAPI, Form
from pydantic import BaseModel

app = FastAPI()


class FormData(BaseModel):
    username: str
    password: str


@app.post("/login/")
async def login(data: FormData = Form()):
    return data

FastAPI extraerá los datos de cada campo del form data en la request y te dará el modelo de Pydantic que definiste.

Revisar la Documentación¶

Puedes verificarlo en la documentación UI en /docs:

Prohibir Campos de Formulario Extra¶

En algunos casos especiales (probablemente no muy comunes), podrías querer restringir los campos del formulario solo a aquellos declarados en el modelo de Pydantic. Y prohibir cualquier campo extra.

Nota

Esto está soportado desde la versión 0.114.0 de FastAPI. 🤓

Puedes usar la configuración del modelo de Pydantic para prohibir cualquier campo extra:

Python 3.10+


from typing import Annotated

from fastapi import FastAPI, Form
from pydantic import BaseModel

app = FastAPI()


class FormData(BaseModel):
    username: str
    password: str
    model_config = {"extra": "forbid"}


@app.post("/login/")
async def login(data: Annotated[FormData, Form()]):
    return data

🤓 Otras versiones y variantes

Python 3.10+ - non-Annotated

Consejo

Preferible usar la versión con Annotated si es posible.


from fastapi import FastAPI, Form
from pydantic import BaseModel

app = FastAPI()


class FormData(BaseModel):
    username: str
    password: str
    model_config = {"extra": "forbid"}


@app.post("/login/")
async def login(data: FormData = Form()):
    return data

Si un cliente intenta enviar datos extra, recibirá una respuesta de error.

Por ejemplo, si el cliente intenta enviar los campos de formulario:

username: Rick
password: Portal Gun
extra: Mr. Poopybutthole

Recibirán una respuesta de error diciéndoles que el campo extra no está permitido:


{
    "detail": [
        {
            "type": "extra_forbidden",
            "loc": ["body", "extra"],
            "msg": "Extra inputs are not permitted",
            "input": "Mr. Poopybutthole"
        }
    ]
}

Resumen¶

Puedes usar modelos de Pydantic para declarar campos de formulario en FastAPI. 😎