Išbeyond tipo tikrinimo, FastAPI leidžia pridėti apribojimus prie kelio/užklausos parametrų ir modelio laukų naudojant Query, Path ir Field — sutvirtindami taisykles tokias kaip ilgis, diapazonai ir šablonai, su automatiniu 422 klaidomis ir dokumentacija, kai pažeidžiami.
from fastapi import Query, Path
@app.get("/items")
def search(
q: str = Query(min_length=3, max_length=50), # string length bounds
page: int = Query(default=1, ge=1), # >= 1
limit: int = Query(default=10, ge=1, le=100), # 1 <= limit <= 100
code: str = Query(pattern=r"^[A-Z]{3}$"), # regex pattern
):
...
@app.get("/items/{item_id}")
def get(item_id: int = Path(ge=1)): # path param must be >= 1
...
Query() ir Path() prideda apribojimus prie užklausos ir kelio parametrų. Bendri: min_length/max_length (eilutės), ge/gt/le/lt (skaičiai), pattern (regex). Pažeidimai automatiškai sukelia aiškią 422 klaidą.
from pydantic import BaseModel, Field, EmailStr
class User(BaseModel):
name: str = Field(min_length=1, max_length=100)
age: int = Field(ge=0, le=120)
email: EmailStr # format validation via a type
bio: str = Field(default="", max_length=500, description="User bio")
Tie patys apribojimai galioja modelio laukams per Field(), validuojant užklausos telkinius. Specializuoti tipai (EmailStr, HttpUrl, UUID) validuoja formatus.
q: str = Query(min_length=3, description="Search query", example="phone")
# the constraints + description + example appear in the auto-generated API docs
Kiekvienas jūsų deklaruotas apribojimas taip pat atspindimas OpenAPI dokumentacijoje, todėl vartotojai mato taisykles.
Validavimo apribojimų pridėjimas yra svarbus tiek saugumui/patikimumui tiek geram API projektavimui — deklaruodami taisykles (ilgio limitai, skaitiniai diapazonai, regex šablonai, formato tipai) užtikrinate, kad blogai suformuotas arba piktas kodas yra atmestas su aiškiomis klaidomis prieš pasiekiant jūsų logiką, o tai yra būtina, nes jūs niekada neturite pasitikėti neapdorotais įvestimais.
FastAPI padarė tai deklaratyvų ir beprasmį: Query/Path/Field apribojimai yra validuojami automatiškai (sukurdami struktūrizuotas 422 klaidas) ir vienu metu dokumentuojami API dokumentuose, todėl taisyklės yra sutvirtintos ir komunikuojamos iš vieno deklaravimo.
Žinojimas apie bendrus apribojimus ir specializuotus validavimo tipus yra kasdienės žinios saugiems, gerai apibrėžtiems taškams statyti — tai yra kaip jūs persitepate pagrindinį tipo tikrinimą į sutvirtinimą tikrųjų verslo taisyklių, kurias jūsų duomenys turi patenkinti.