ਟਾਈਪ ਚੈਕਿੰਗ ਤੋਂ ਪਰੇ, FastAPI ਤੁਹਾਨੂੰ Query, Path, ਅਤੇ Field ਦੀ ਵਰਤੋਂ ਕਰਕੇ path/query ਪੈਰਾਮੀਟਰਾਂ ਅਤੇ ਮਾਡਲ ਫੀਲਡਾਂ ਵਿੱਚ constraints ਜੋੜਨ ਦਿੰਦਾ ਹੈ — ਲੰਬਾਈ, ਰੇਂਜ, ਅਤੇ ਪੈਟਰਨ ਵਰਗੇ ਨਿਯਮਾਂ ਨੂੰ ਲਾਗੂ ਕਰਦੇ ਹੋਏ, ਵਾਇਲੇਸ਼ਨ ਹੋਣ ਤੇ ਆਟੋਮੈਟਿਕ 422 ਐਰਰਾਂ ਅਤੇ ਡਾਕੂਮੈਂਟੇਸ਼ਨ ਨਾਲ।
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 (ਸਟ੍ਰਿੰਗਾਂ ਲਈ), ge/gt/le/lt (ਨੰਬਰਾਂ ਲਈ), pattern (regex)। ਵਾਇਲੇਸ਼ਨਾਂ ਆਟੋਮੈਟਿਕ ਤੌਰ ਤੇ ਸਪੱਸ਼ਟ 422 ਐਰਰ ਪੈਦਾ ਕਰਦੀਆਂ ਹਨ।
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() ਦੇ ਜ਼ਰੀਏ ਮਾਡਲ ਫੀਲਡਾਂ ਤੇ ਲਾਗੂ ਹੁੰਦੇ ਹਨ, ਰਿਕਿਊਸਟ ਬੌਡੀਜ਼ ਨੂੰ ਵੈਲੀਡੇਟ ਕਰਦੇ ਹਨ। ਸਪੈਸ਼ਲਾਈਜ਼ਡ ਟਾਈਪਾਂ (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 ਡਾਕੂਮੈਂਟੇਸ਼ਨ ਵਿੱਚ ਵੀ ਪ੍ਰਤੀਬਿੰਬਤ ਹੁੰਦਾ ਹੈ, ਇਸ ਲਈ ਖਪਤਕਾਰ ਨਿਯਮਾਂ ਨੂੰ ਦੇਖ ਸਕਦੇ ਹਨ।
Validation constraints ਜੋੜਨਾ ਸੁਰੱਖਿਆ/ਮਜ਼ਬੂਤੀ ਅਤੇ ਚੰਗੀ API ਡਿਜ਼ਾਈਨ ਦੋਵਾਂ ਲਈ ਮਹੱਤਵਪੂਰਨ ਹੈ — ਨਿਯਮਾਂ ਦੀ ਘੋਸ਼ਣਾ ਕਰਨਾ (ਲੰਬਾਈ ਦੀ ਸੀਮਾਵਾਂ, ਨੰਬਰ ਦੀਆਂ ਰੇਂਜਾਂ, regex ਪੈਟਰਨ, ਫਾਰਮੈਟ ਟਾਈਪਾਂ) ਯਕੀਨੀ ਬਣਾਉਂਦਾ ਹੈ ਕਿ ਗ਼ਲਤ ਜਾਂ ਖ਼ਤਰਨਾਕ ਇਨਪੁਟ ਸਪੱਸ਼ਟ ਐਰਰਾਂ ਨਾਲ ਰਿਜੈਕਟ ਕੀਤਾ ਜਾਂਦਾ ਹੈ ਤੁਹਾਡੇ ਲੌਜ਼ਿਕ ਤੱਕ ਪਹੁੰਚਣ ਤੋਂ ਪਹਿਲਾਂ, ਜੋ ਜ਼ਰੂਰੀ ਹੈ ਕਿਉਂਕਿ ਤੁਹਾਨੂੰ ਕਦੀ ਵੀ ਸਾਧਾਰਨ ਇਨਪੁਟ 'ਤੇ ਭਰੋਸਾ ਨਹੀਂ ਕਰਨਾ ਚਾਹੀਦਾ।
FastAPI ਇਸ ਨੂੰ ਡਿਕਲੇਰੇਟਿਵ ਅਤੇ ਅਨਮੋਲ ਬਣਾਉਂਦਾ ਹੈ: Query/Path/Field constraints ਆਟੋਮੈਟਿਕ ਤੌਰ ਤੇ ਵੈਲੀਡੇਟ ਹੁੰਦੇ ਹਨ (ਸਟ੍ਰਕਚਰਡ 422 ਐਰਰਾਂ ਪੈਦਾ ਕਰਦੇ ਹਨ) ਅਤੇ ਇੱਕ ਸਿੰਗਲ ਡਿਕਲੇਰੇਸ਼ਨ ਤੋਂ ਬਾਅਦ ਤੋਂ API ਡੌਕਸ ਵਿੱਚ ਦਸਤਾਵੇਜ਼ ਕੀਤੇ ਜਾਂਦੇ ਹਨ, ਇਸ ਲਈ ਨਿਯਮ ਲਾਗੂ ਅਤੇ ਸੰਚਾਰ ਕੀਤੇ ਜਾਂਦੇ ਹਨ।
ਆਮ constraints ਅਤੇ ਸਪੈਸ਼ਲਾਈਜ਼ਡ ਵੈਲੀਡੇਸ਼ਨ ਟਾਈਪਾਂ ਨੂੰ ਜਾਣਨਾ ਰੋਜ਼ਮਰਾਂਦੀ ਜਾਣਕਾਰੀ ਹੈ ਸੁਰੱਖਿਅਤ, ਚੰਗੀ ਤਰ੍ਹਾਂ ਪਰਿਭਾਸ਼ਿਤ endpoints ਬਿਲਡ ਕਰਨ ਲਈ — ਇਹ ਬੁਨਿਆਦੀ ਟਾਈਪ ਚੈਕਿੰਗ ਦੇ ਪਾਰ ਜਾਣਾ ਹੈ ਤੁਹਾਡੇ ਡਾਟਾ ਨੂੰ ਸੰਤੁਸ਼ਟ ਕਰਨੇ ਚਾਹੀਦੇ ਬਿਜਨਸ ਨਿਯਮਾਂ ਨੂੰ ਲਾਗੂ ਕਰਨ ਲਈ।