पाथ और क्वेरी पैरामीटर कैसे काम करते हैं?

Question

Accepted Answer

FastAPI फ़ंक्शन आर्गुमेंट्स से **पाथ पैरामीटर** (URL पाथ का हिस्सा) और **क्वेरी पैरामीटर** (`?` के बाद) निकालता है, उन्हें स्वचलित रूप से परिवर्तित और सत्यापित करने के लिए टाइप हिंट्स का उपयोग करते हुए।

## पाथ पैरामीटर — URL का हिस्सा

```python
@app.get("/items/{item_id}")        # {item_id} in the path
def get_item(item_id: int):          # matched by NAME; `int` converts & validates
    return {"item_id": item_id}
# GET /items/5 → item_id = 5 (int).  GET /items/abc → 422 error (not an int)
```

एक फ़ंक्शन पैरामीटर जिसका नाम पाथ में `{placeholder}` से मेल खाता है, एक **पाथ पैरामीटर** बन जाता है। टाइप हिंट (`int`) URL से स्ट्रिंग को स्वचलित रूप से परिवर्तित करता है और यदि यह मेल नहीं खाता तो स्पष्ट 422 त्रुटि देता है।

## क्वेरी पैरामीटर — बाकी सब कुछ

```python
@app.get("/items")
def list_items(skip: int = 0, limit: int = 10, q: str | None = None):
    # parameters NOT in the path become QUERY parameters
    # GET /items?skip=20&limit=5&q=phone → skip=20, limit=5, q="phone"
    return {"skip": skip, "limit": limit, "q": q}
```

फ़ंक्शन पैरामीटर जो पाथ में **नहीं** हैं **क्वेरी पैरामीटर** बन जाते हैं। एक डिफ़ॉल्ट मान उन्हें वैकल्पिक बनाता है (`skip: int = 0`) ; `str | None = None` एक शून्य वैकल्पिक क्वेरी पैरामीटर बनाता है। डिफ़ॉल्ट के बिना, वे आवश्यक हैं।

## आवश्यक बनाम वैकल्पिक

```python
def search(q: str):              # REQUIRED query param (no default) → ?q=... must be present
def search(q: str = ""):          # optional, defaults to ""
def search(q: str | None = None): # optional, defaults to None
```

## दोनों को संयोजित करना

```python
@app.get("/users/{user_id}/items")
def user_items(user_id: int, limit: int = 10):
    # user_id = path param, limit = query param — distinguished by the path
```

## यह क्यों महत्वपूर्ण है

पाथ और क्वेरी पैरामीटर वह तरीका हैं जिसमें एंडपॉइंट्स URL से इनपुट प्राप्त करते हैं — लगभग हर API रूट के लिए मौलिक (ID द्वारा संसाधन प्राप्त करना, फिल्टरिंग, पेजिंग, खोज)।

FastAPI का दृष्टिकोण सुरुचिपूर्ण है और यह कारण है कि यह उत्पादक है: केवल टाइप किए गए फ़ंक्शन पैरामीटर घोषित करना आपको स्वचलित निष्कर्षण, **टाइप रूपांतरण**, **सत्यापन** (बुरे इनपुट पर स्पष्ट 422 त्रुटियों के साथ) और आवश्यक-बनाम-वैकल्पिक शब्दार्थ (डिफ़ॉल्ट के माध्यम से) देता है — सब कुछ मानक Python टाइप हिंट्स से प्राप्त, कोई मैनुअल पार्सिंग नहीं।

अंतर को समझना (पाथ पैरामीटर `{placeholders}` से आते हैं, बाकी सब कुछ एक क्वेरी पैरामीटर है) और कैसे डिफ़ॉल्ट वैकल्पिकता को नियंत्रित करते हैं FastAPI एंडपॉइंट्स बनाने के लिए आवश्यक दैनिक ज्ञान है।