Modelos de Formulario¶

🌐 Traducción por IA y humanos

Esta traducción fue hecha por IA guiada por humanos. 🤝

Podría tener errores al interpretar el significado original, o sonar poco natural, etc. 🤖

Puedes mejorar esta traducción ayudándonos a guiar mejor al LLM de IA.

Versión en inglés

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:

$ pipinstallpython-multipart

Nota

Esto es compatible 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+

fromtypingimport Annotated
fromfastapiimport FastAPI, Form
frompydanticimport BaseModel
app = FastAPI()
classFormData(BaseModel):
 username: str
 password: str
@app.post("/login/")
async deflogin(data: Annotated[FormData, Form()]):
 return data

🤓 Other versions and variants

Python 3.10+ - non-Annotated

Tip

Prefer to use the Annotated version if possible.

fromfastapiimport FastAPI, Form
frompydanticimport BaseModel
app = FastAPI()
classFormData(BaseModel):
 username: str
 password: str
@app.post("/login/")
async deflogin(data: FormData = Form()):
 return data

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

Revisa la Documentación¶

Puedes verificarlo en la interfaz de documentación en /docs:

Prohibir Campos de Formulario Extra¶

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

Nota

Esto es compatible desde la versión 0.114.0 de FastAPI. 🤓

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

Python 3.10+

fromtypingimport Annotated
fromfastapiimport FastAPI, Form
frompydanticimport BaseModel
app = FastAPI()
classFormData(BaseModel):
 username: str
 password: str
 model_config = {"extra": "forbid"}
@app.post("/login/")
async deflogin(data: Annotated[FormData, Form()]):
 return data

🤓 Other versions and variants

Python 3.10+ - non-Annotated

Tip

Prefer to use the Annotated version if possible.

fromfastapiimport FastAPI, Form
frompydanticimport BaseModel
app = FastAPI()
classFormData(BaseModel):
 username: str
 password: str
 model_config = {"extra": "forbid"}
@app.post("/login/")
async deflogin(data: FormData = Form()):
 return data

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

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

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

Recibirá un response de error indicando 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. 😎