表单模型¶

您可以使用 Pydantic 模型 来声明 FastAPI 中的 表单字段。

信息

要使用表单，请先安装 python-multipart。

确保你创建一个虚拟环境，激活它，然后安装它，例如：

$ pip install python-multipart

注意

此功能自 FastAPI 版本 0.113.0 起受支持。 🤓

用于表单的 Pydantic 模型¶

您只需声明一个 Pydantic 模型，其中包含您想接收的 表单字段，然后将该参数声明为 Form。

Python 3.9+

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

🤓 其他版本和变体

Python 3.9+ - 非注解

提示

如果可能，请优先使用 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: FormData = Form()):
    return data

FastAPI 将从请求的 表单数据 中提取 每个字段 的数据，并为您提供定义的 Pydantic 模型。

查看文档¶

您可以在 /docs 的文档 UI 中进行验证。

禁止额外的表单字段¶

在一些特殊用例中（可能并不常见），您可能希望将表单字段限制为仅包含 Pydantic 模型中声明的字段。并禁止任何额外字段。

注意

此功能自 FastAPI 版本 0.114.0 起受支持。 🤓

你可以使用 Pydantic 的模型配置来 forbid 任何 extra 字段

Python 3.9+

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

🤓 其他版本和变体

Python 3.9+ - 非注解

提示

如果可能，请优先使用 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: FormData = Form()):
    return data

如果客户端尝试发送一些额外数据，他们将收到一个错误响应。

例如，如果客户端尝试发送表单字段

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

他们将收到一个错误响应，告知他们不允许 extra 字段。

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

总结¶

您可以使用 Pydantic 模型来声明 FastAPI 中的表单字段。 😎