表单数据¶
当你需要接收表单字段而不是 JSON 时，可以使用 Form。
导入 Form¶
从 fastapi 导入 Form：
from typing import Annotated
from fastapi import FastAPI, Form
app = FastAPI()
@app.post("/login/")
async def login(username: Annotated[str, Form()], password: Annotated[str, Form()]):
return {"username": username}
from fastapi import FastAPI, Form
from typing_extensions import Annotated
app = FastAPI()
@app.post("/login/")
async def login(username: Annotated[str, Form()], password: Annotated[str, Form()]):
return {"username": username}
Tip
如果可能，优先使用 Annotated 版本。
from fastapi import FastAPI, Form
app = FastAPI()
@app.post("/login/")
async def login(username: str = Form(), password: str = Form()):
return {"username": username}
定义 Form 参数¶
创建表单参数的方式与 Body 或 Query 相同：
from typing import Annotated
from fastapi import FastAPI, Form
app = FastAPI()
@app.post("/login/")
async def login(username: Annotated[str, Form()], password: Annotated[str, Form()]):
return {"username": username}
from fastapi import FastAPI, Form
from typing_extensions import Annotated
app = FastAPI()
@app.post("/login/")
async def login(username: Annotated[str, Form()], password: Annotated[str, Form()]):
return {"username": username}
Tip
如果可能，优先使用 Annotated 版本。
from fastapi import FastAPI, Form
app = FastAPI()
@app.post("/login/")
async def login(username: str = Form(), password: str = Form()):
return {"username": username}
例如，在使用 OAuth2 规范的一种方式（称为“密码流”）时，需要发送 username 和 password 作为表单字段。
spec 要求字段必须准确命名为 username 和 password，并且作为表单字段发送，而不是 JSON。
使用 Form，你可以声明与 Body（以及 Query、Path、Cookie）相同的配置，包括验证、示例、别名（例如 user-name 代替 username）等。
Info
Form 是一个直接继承自 Body 的类。
Tip
要声明表单体，你需要显式使用 Form，因为如果不使用它，参数将被解释为查询参数或 JSON 参数。
关于“表单字段”¶
HTML 表单（<form></form>）通常使用一种“特殊”的编码方式将数据发送到服务器，这与 JSON 不同。
FastAPI 将确保从正确的位置读取该数据，而不是 JSON。
“技术细节”
表单数据通常使用“媒体类型” application/x-www-form-urlencoded 进行编码。
但当表单包含文件时，它被编码为 multipart/form-data。你将在下一章中了解如何处理文件。
如果你想了解更多关于这些编码和表单字段的信息，请访问 MDN web docs for POST。
Warning
你可以在一个 路径操作 中声明多个 Form 参数，但你不能同时声明期望接收为 JSON 的 Body 字段，因为请求将使用 application/x-www-form-urlencoded 而不是 application/json 编码。
这不是 FastAPI 的限制，而是 HTTP 协议的一部分。
总结¶
使用 Form 来声明表单数据输入参数。