Form Verisi¶
İstek gövdesinde JSON verisi yerine form alanlarını karşılamanız gerketiğinde Form
sınıfını kullanabilirsiniz.
"Bilgi"
Formları kullanmak için öncelikle python-multipart
paketini indirmeniz gerekmektedir.
Örneğin pip install python-multipart
.
Form
Sınıfını Projenize Dahil Edin¶
Form
sınıfını fastapi
'den projenize dahil edin:
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
Prefer to use the Annotated
version if possible.
from fastapi import FastAPI, Form
app = FastAPI()
@app.post("/login/")
async def login(username: str = Form(), password: str = Form()):
return {"username": username}
Form
Parametrelerini Tanımlayın¶
Form parametrelerini Body
veya Query
için yaptığınız gibi oluşturun:
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
Prefer to use the Annotated
version if possible.
from fastapi import FastAPI, Form
app = FastAPI()
@app.post("/login/")
async def login(username: str = Form(), password: str = Form()):
return {"username": username}
Örneğin, OAuth2 spesifikasyonunun kullanılabileceği ("şifre akışı" olarak adlandırılan) yollardan birinde, form alanları olarak "username" ve "password" gönderilmesi gerekir.
Bu spesifikasyon form alanlarını adlandırırken isimlerinin birebir username
ve password
olmasını ve JSON verisi yerine form verisi olarak gönderilmesini gerektirir.
Form
sınıfıyla tanımlama yaparken Body
, Query
, Path
ve Cookie
sınıflarında kullandığınız aynı validasyon, örnekler, isimlendirme (örneğin username
yerine user-name
kullanımı) ve daha fazla konfigurasyonu kullanabilirsiniz.
"Bilgi"
Form
doğrudan Body
sınıfını miras alan bir sınıftır.
"İpucu"
Form gövdelerini tanımlamak için Form
sınıfını kullanmanız gerekir; çünkü bu olmadan parametreler sorgu parametreleri veya gövde (JSON) parametreleri olarak yorumlanır.
"Form Alanları" Hakkında¶
HTML formlarının (<form></form>
) verileri sunucuya gönderirken JSON'dan farklı özel bir kodlama kullanır.
FastAPI bu verilerin JSON yerine doğru şekilde okunmasını sağlayacaktır.
"Teknik Detaylar"
Form verileri normalde application/x-www-form-urlencoded
medya tipiyle kodlanır.
Ancak form içerisinde dosyalar yer aldığında multipart/form-data
olarak kodlanır. Bir sonraki bölümde dosyaların işlenmesi hakkında bilgi edineceksiniz.
Form kodlama türleri ve form alanları hakkında daha fazla bilgi edinmek istiyorsanız MDN web docs for POST
sayfasını ziyaret edebilirsiniz.
"Uyarı"
Yol operasyonları içerisinde birden fazla Form
parametresi tanımlayabilirsiniz ancak bunlarla birlikte JSON verisi kabul eden Body
alanları tanımlayamazsınız çünkü bu durumda istek gövdesi application/json
yerine application/x-www-form-urlencoded
ile kodlanmış olur.
Bu FastAPI'ın getirdiği bir kısıtlama değildir, HTTP protokolünün bir parçasıdır.
Özet¶
Form verisi girdi parametreleri tanımlamak için Form
sınıfını kullanın.