fastapi/docs/zh/docs/tutorial/request-form-models.md

表单模型

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

/// info | 信息

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

确保你创建一个虚拟环境{.internal-link target=_blank}，激活它，然后再安装，例如：

$ pip install python-multipart

///

/// note | 注意

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

///

表单的 Pydantic 模型

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

{* ../../docs_src/request_form_models/tutorial001_an_py310.py hl[9:11,15] *}

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

检查文档

你可以在文档 UI 中验证它，地址为 /docs：

禁止额外的表单字段

在某些特殊使用情况下（可能并不常见），你可能希望将表单字段限制为仅在 Pydantic 模型中声明过的字段，并禁止任何额外的字段。

/// note | 注意

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

///

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

{* ../../docs_src/request_form_models/tutorial002_an_py310.py hl[12] *}

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

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

• 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 中声明表单字段。😎