როგორ დაამატებთ ვალიდაციის შეზღუდვებს პარამეტრებზე?

Question

Accepted Answer

ტიპის შემოწმების გარდა, FastAPI საშუალებას გაძლევთ დაამატოთ **შეზღუდვები** path/query პარამეტრებზე და მოდელის ველებზე `Query`, `Path` და `Field` გამოყენებით — იძულებს წესებს როგორიცაა სიგრძე, დიაპაზონი და შაბლონები, ავტომატური 422 შეცდომებით და დოკუმენტაციით დარღვევის შემთხვევაში. ## Query და 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()` და `Path()` დაამატებს შეზღუდვებს query და path პარამეტრებზე. გავრცელებული ვარიანტები: `min_length`/`max_length` (სტრიქონები), `ge`/`gt`/`le`/`lt` (რიცხვები), `pattern` (regex). დარღვევები ავტომატურად აწარმოებს გასაგებ 422 შეცდომას. ## ველის შეზღუდვები 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") ``` იგივე შეზღუდვები ვრცელდება მოდელის ველებზე `Field()` მეშვეობით, რეკვესტის სხეულის ვალიდაციისას. სპეციალიზებული ტიპები (`EmailStr`, `HttpUrl`, `UUID`) ვალიდაციას უტარებს ფორმატებს. ## შეზღუდვები აგრეთვე აამდიდებს დოკუმენტაციას ```python q: str = Query(min_length=3, description="Search query", example="phone") # the constraints + description + example appear in the auto-generated API docs ``` ყველა შეზღუდვა, რომელსაც თქვენ გამოაცხადებთ, ასევე ასახულია OpenAPI დოკუმენტაციაში, ასე რომ მომხმარებელი ხედავს წესებს. ## რატომ მნიშვნელოვანია ვალიდაციის შეზღუდვების დამატება მნიშვნელოვანია **უსაფრთხოების/სიმტკიცის** და კარგი API დიზაინის კუთხით — წესების გამოცხადება (სიგრძის ლიმიტები, რიცხვითი დიაპაზონი, regex შაბლონები, ფორმატის ტიპები) უზრუნველყოფს, რომ არასწორად ან ბოროტად ჩამოყალიბებული ინპუტი უარყოფილია გასაგებ შეცდომებით *თქვენი ლოგიკის გაწვდომdens*, რაც გადამწყვეტია, რადგან აბსოლუტურად არ უნდა დაეყრდნოთ ნედლ ინპუტს. FastAPI ამას ღრმა და მარტივს ხდის: `Query`/`Path`/`Field` შეზღუდვები ავტომატურად ვალიდაციას უტარდება (აწარმოებს სტრუქტურირებულ 422 შეცდომას) და ერთდროულად დოკუმენტირებული API დოკებში, ასე რომ წესები ასრულებული და კომუნიკაციაა ერთიანი გამოცხადებიდან. გავრცელებული შეზღუდვებისა და სპეციალიზებული ვალიდაციის ტიპების ცოდნა ყოველდღიური ცოდნაა უსაფრთხო, კარგად განსაზღვრული ენდპოინტების აგებისთვის — ეს იმ ხერხია, როგორ მოხვიდეთ ძირითადი ტიპის შემოწმების ფარგლებს აქ უზრუნველყოთ ფაქტობრივი ბიზნეს წესები, რომელსაც თქვენი მონაცემები უნდა აკმაყოფილებდეს.