表单模型

你可以使用 Pydantic 模型 在 FastAPI 中声明 表单字段。

Info

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

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

$ pip install python-multipart

Note

从 FastAPI 版本 0.113.0 开始支持此功能。🤓

表单的 Pydantic 模型

你只需要声明一个包含你希望接收的 表单字段 的 Pydantic 模型，然后将参数声明为 Form：

Python 3.9+Python 3.8+Python 3.8+ non-Annotated

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

from fastapi import FastAPI, Form
from pydantic import BaseModel
from typing_extensions import Annotated

app = FastAPI()


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


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

Tip

如果可能，建议使用 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 模型中声明的字段。并 禁止 任何 额外 字段。

Note

从 FastAPI 版本 0.114.0 开始支持此功能。🤓

你可以使用 Pydantic 的模型配置来 禁止 任何 额外 字段：

Python 3.9+Python 3.8+Python 3.8+ non-Annotated

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

from fastapi import FastAPI, Form
from pydantic import BaseModel
from typing_extensions import Annotated

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

Tip

如果可能，建议使用 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"
        }
    ]
}

总结

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