టైప్ చెక్కింగ్ కంటే ఎక్కువ, FastAPI Query, Path, మరియు Field ఉపయోగించి path/query పారామీటర్లకు మరియు మోడల్ ఫీల్డ్లకు constraints జోడించడానికి మిమ్మల్ని అనుమతిస్తుంది — length, ranges, మరియు patterns వంటి నియమలను ఎన్ఫోర్స్ చేస్తుంది, ఉల్లంఘన సందర్భంలో స్వయంచాలక 422 errors మరియు డాక్యుమెంటేషన్ను అందిస్తుంది.
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 పారామీటర్లకు constraints జోడిస్తాయి. సాధారణ వాటి: min_length/max_length (strings), ge/gt/le/lt (numbers), pattern (regex). ఉల్లంఘనలు స్వయంచాలకంగా స్పష్టమైన 422 error ఉత్పత్తి చేస్తాయి.
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")
పై నిర్వచించిన constraints మోడల్ ఫీల్డ్లకు Field() ద్వారా వర్తిస్తాయి, request bodies ని ఆమోదించుకుంటాయి. స్పెషలైజ్డ్ types (EmailStr, HttpUrl, UUID) ఫార్మాట్లను ఆమోదించుకుంటాయి.
q: str = Query(min_length=3, description="Search query", example="phone")
# the constraints + description + example appear in the auto-generated API docs
ప్రతిটి constraint ని మీరు ఘోషించిన OpenAPI డాక్యుమెంటేషన్లో కూడా ప్రతిబింబిస్తుంది, కాబట్టి వినియోగదారులు నియమలను చూస్తారు.
ఆమోదన constraints జోడించడం security/robustness మరియు మంచి API డిజైన్ రెండింటికీ ముఖ్యమైనది — నియమలను (length limits, numeric ranges, regex patterns, format types) ఘోషించడం, malformed లేదా malicious input స్పష్టమైన errors తో స్వీకరించబడకుండా తిరస్కరించబడిందని నిశ్చితం చేస్తుంది ఆपনার logic కు చేరకముందే, ఇది ఎంతో ముఖ్యమైనది ఎందుకంటే మీరు raw input కు ఎప్పుడూ విశ్వాసం చేయకూడదు.
FastAPI ఇది declarative మరియు సులభం చేస్తుంది: Query/Path/Field constraints స్వయంచాలకంగా ఆమోదించబడతాయి (structured 422 errors ఉత్పత్తి చేస్తుంది) మరియు simultaneously API docs లో డాక్యుమెంట్ చేయబడతాయి, కాబట్టి నియమలు ఒకే ఘోషణ నుండి ఎన్ఫోర్స్ చేయబడతాయి మరియు సంప్రేషించబడతాయి.
సాధారణ constraints మరియు specialized validation types తెలుసుకోవడం safe, well-defined endpoints నిర్మించడానికి రోజువారీ జ్ఞానం — ఇది ఎలా మీరు basic type checking దాటి వెళ్లి ఆపনার డేటా సంతృప్తి చేయవలసిన నిజమైన business rules ని ఎన్ఫోర్స్ చేస్తారు.