પ્રકારની તપાસ ઉપરાંત, FastAPI તમને Query, Path, અને Field નો ઉપયોગ કરીને પાથ/ક્વેરી પરિમાણો અને મોડેલ ક્ષેત્રોમાં મર્યાદાઓ ઉમેરવાની પરવાનગી આપે છે — લંબાઈ, શ્રેણીઓ અને પેટર્નની જેમ નિયમો લાગુ કરે છે, સ્વચાલિત 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() ક્વેરી અને પાથ પરિમાણોમાં મર્યાદાઓ ઉમેરે છે. સામાન્ય લોકો: 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")
સમાન મર્યાદાઓ 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
તમે જે દરેક મર્યાદા ઘોષણા કરો છો તે OpenAPI દસ્તાવેજમાં પણ પ્રતિબિંબિત થાય છે, તેથી ગ્રાહકો નિયમો જુએ છે.
ચકાસણી મર્યાદાઓ ઉમેરવી સુરક્ષા/મજબૂતાઈ અને સારા API ડિઝાઈન બંને માટે મહત્વપૂર્ણ છે — નિયમોની જાહેરાત કરવી (લંબાઈ મર્યાદાઓ, સંખ્યાત્મક શ્રેણીઓ, regex પેટર્નો, ફોર્મેટ પ્રકારો) ખાતરી આપે છે કે ખરાબ રીતે રચાયેલ અથવા દૂષિત ઇનપુટ સ્પષ્ટ ભૂલો સાથે નકારી કાઢવામાં આવે છે તમારા તર્કમાં પહોંચતા પહેલાં, જે આવશ્યક છે કારણ કે તમે ક્યારેય કાચા ઇનપુટ પર વિશ્વાસ કરવો જોઈએ નહીં.
FastAPI આને ઘોષણાત્મક અને સરળ બનાવે છે: Query/Path/Field મર્યાદાઓ સ્વચાલિત રીતે ચકાસવામાં આવે છે (માળખાબદ્ધ 422 ભૂલો ઉત્પાદન કરે છે) અને એક સાથે API દસ્તાવેજમાં ડોકુમેન્ટ કરવામાં આવે છે, તેથી નિયમો એક જ જાહેરાત અંતર્ગત લાગુ અને સંચાર કરવામાં આવે છે.
સામાન્ય મર્યાદાઓ અને વિશેષાધિકાર પ્રાપ્ત ચકાસણી પ્રકારો જાણવું સુરક્ષિત, સારી રીતે વ્યાખ્યાયિત એન્ડપોઇન્ટ્સ બનાવવા માટે રોજિંદો જ્ઞાન છે — તમે મૂળભૂત પ્રકારની તપાસ ઉપરાંત કેવી રીતે આગળ જાઓ છો તે છે તમારા ડેટાને સંતોષ કરવી આવશ્યક છે તે વાસ્તવિક વ્યવસાય નિયમો લાગુ કરવા.