表单数据

    说明

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

    例如，pip install python-multipart。

    从 fastapi 导入 Form：

    创建表单（Form）参数的方式与 Body 和 Query 一样：

    1. from fastapi import FastAPI, Form
    5. @app.post("/login/")
    6. async def login(username: str = Form(), password: str = Form()):

    例如，OAuth2 规范的 “密码流” 模式规定要通过表单字段发送 username 和 password。

    使用 Form 可以声明与 Body （及 Query、、Cookie）相同的元数据和验证。

    说明

    Form 是直接继承自 Body 的类。

    提示

    声明表单体要显式使用 Form ，否则，FastAPI 会把该参数当作查询参数或请求体（JSON）参数。

    与 JSON 不同，HTML 表单（<form></form>）向服务器发送数据通常使用「特殊」的编码。

    技术细节

    表单数据的「媒体类型」编码一般为 application/x-www-form-urlencoded。

    但包含文件的表单编码为 multipart/form-data。文件处理详见下节。

    编码和表单字段详见 MDN Web 文档的 POST小节。

    警告

    可在一个路径操作中声明多个 Form 参数，但不能同时声明要接收 JSON 的 Body 字段。因为此时请求体的编码是 application/x-www-form-urlencoded，不是 application/json。

    本节介绍了如何使用 Form 声明表单数据输入参数。