表单模型

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

信息

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

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

$ pip install python-multipart

注意

这是从 FastAPI 版本 0.113.0 开始支持的。🤓

用于表单的 Pydantic 模型

您只需要使用要作为 **表单字段** 接收的字段声明一个 **Pydantic 模型**，然后将参数声明为 Form

Python 3.9+Python 3.8+Python 3.8+ 非 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

提示

如果可能，请优先使用 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+Python 3.8+Python 3.8+ 非 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

提示

如果可能，请优先使用 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 模型来声明表单字段。😎