FastAPI教程 表單數(shù)據(jù)

2022-08-20 11:41 更新

接收的不是 JSON,而是表單字段時,要使用 Form。

說明

要使用表單,需預先安裝 python-multipart。

例如,pip install python-multipart。

導入 Form

從 fastapi 導入 Form:

from fastapi import FastAPI, Form

app = FastAPI()


@app.post("/login/")
async def login(username: str = Form(...), password: str = Form(...)):
    return {"username": username}

定義 Form 參數(shù)

創(chuàng)建表單(Form)參數(shù)的方式與 Body 和 Query 一樣:

from fastapi import FastAPI, Form

app = FastAPI()


@app.post("/login/")
async def login(username: str = Form(...), password: str = Form(...)):
    return {"username": username}

例如,OAuth2 規(guī)范的 "密碼流" 模式規(guī)定要通過表單字段發(fā)送 username 和 password。

該規(guī)范要求字段必須命名為 username 和 password,并通過表單字段發(fā)送,不能用 JSON。

使用 Form 可以聲明與 Body (及 Query、Path、Cookie)相同的元數(shù)據(jù)和驗證。

說明

Form 是直接繼承自 Body 的類。

提示

聲明表單體要顯式使用 Form ,否則,F(xiàn)astAPI 會把該參數(shù)當作查詢參數(shù)或請求體(JSON)參數(shù)。

關于 "表單字段"

與 JSON 不同,HTML 表單(<form></form>)向服務器發(fā)送數(shù)據(jù)通常使用「特殊」的編碼。

FastAPI 要確保從正確的位置讀取數(shù)據(jù),而不是讀取 JSON。

技術細節(jié)

表單數(shù)據(jù)的「媒體類型」編碼一般為 application/x-www-form-urlencoded。

但包含文件的表單編碼為 multipart/form-data。文件處理詳見下節(jié)。

編碼和表單字段詳見 MDN Web 文檔的 POST小節(jié)。

警告

可在一個路徑操作中聲明多個 Form 參數(shù),但不能同時聲明要接收 JSON 的 Body 字段。因為此時請求體的編碼是 application/x-www-form-urlencoded,不是 application/json。

這不是 FastAPI 的問題,而是 HTTP 協(xié)議的規(guī)定。

小結

本節(jié)介紹了如何使用 Form 聲明表單數(shù)據(jù)輸入?yún)?shù)。


以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號