Unaongezaje vikwazo vya uthibitishaji (validation constraints) kwenye parameta?

Question

Accepted Answer

Zaidi ya ukaguzi wa aina, FastAPI inakuruhusu kuongeza **vikwazo** kwenye parameta za path/query na sehemu za modeli ukitumia `Query`, `Path`, na `Field` — kutekeleza sheria kama urefu, masafa, na mifumo (patterns), pamoja na hitilafu za 422 za kiotomatiki na nyaraka pale zinapokiukwa. ## Vikwazo vya Query na Path ```python 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()` na `Path()` huongeza vikwazo kwenye parameta za query na path. Vya kawaida: `min_length`/`max_length` (strings), `ge`/`gt`/`le`/`lt` (namba), `pattern` (regex). Ukiukaji huzalisha hitilafu wazi ya 422 kiotomatiki. ## Vikwazo vya Field kwenye modeli za Pydantic ```python 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") ``` Vikwazo vile vile vinatumika kwenye sehemu za modeli kupitia `Field()`, kuthibitisha miili ya maombi (request bodies). Aina maalum (`EmailStr`, `HttpUrl`, `UUID`) huthibitisha mifumo (formats). ## Vikwazo pia huboresha nyaraka ```python q: str = Query(min_length=3, description="Search query", example="phone") # the constraints + description + example appear in the auto-generated API docs ``` Kila kikwazo unachotangaza pia kinaonekana kwenye nyaraka za OpenAPI, hivyo watumiaji huona sheria hizo. ## Kwa nini ni muhimu Kuongeza vikwazo vya uthibitishaji ni muhimu kwa **usalama/uimara** na muundo mzuri wa API — kutangaza sheria (vikomo vya urefu, masafa ya namba, mifumo ya regex, aina za muundo) huhakikisha kuwa ingizo lililoharibika au hatari linakataliwa kwa hitilafu wazi *kabla* ya kufikia mantiki yako, jambo la lazima kwa kuwa kamwe hupaswi kuamini ingizo ghafi. FastAPI inafanya hili kuwa la kutangaza na rahisi: vikwazo vya `Query`/`Path`/`Field` huthibitishwa kiotomatiki (vikizalisha hitilafu 422 zilizopangwa) na wakati huo huo kuandikwa kwenye nyaraka za API, hivyo sheria hutekelezwa na kuwasilishwa kutoka tangazo moja. Kujua vikwazo vya kawaida na aina maalum za uthibitishaji ni maarifa ya kila siku ya kujenga endpoints salama na zilizofafanuliwa vizuri — ndivyo unavyoenda zaidi ya ukaguzi wa aina wa msingi ili kutekeleza sheria halisi za biashara ambazo data yako lazima izitimize.