आप स्टेटस कोड और हेडर कैसे सेट करते हैं?

Question

Accepted Answer

FastAPI डिफ़ॉल्ट रूप से `200 OK` लौटाता है, लेकिन जब आपको अलग व्यवहार की आवश्यकता हो तो आप **स्टेटस कोड** (डेकोरेटर या प्रतिक्रिया ऑब्जेक्ट के माध्यम से) और **हेडर** को नियंत्रित करते हैं — उचित REST शब्दार्थ के लिए महत्वपूर्ण।

## रूट पर डिफ़ॉल्ट स्टेटस कोड सेट करना

```python
from fastapi import status

@app.post("/items", status_code=status.HTTP_201_CREATED)   # 201 for resource creation
def create_item(item: Item):
    return item                                             # returns with 201

@app.delete("/items/{id}", status_code=status.HTTP_204_NO_CONTENT)  # 204
def delete_item(id: int):
    ...
```

`status_code` डेकोरेटर पैरामीटर डिफ़ॉल्ट सफलता स्थिति सेट करता है। `status` स्थिरांकों (जैसे `status.HTTP_201_CREATED`) का उपयोग करना जादुई संख्याओं से अधिक स्पष्ट है। सही कोड महत्वपूर्ण हैं: बनाए गए के लिए `201`, कोई सामग्री नहीं के लिए `204`, आदि।

## Response ऑब्जेक्ट के माध्यम से गतिशील स्टेटस कोड और हेडर

```python
from fastapi import Response

@app.get("/items/{id}")
def get_item(id: int, response: Response):
    item = db.get(id)
    if not item:
        response.status_code = status.HTTP_404_NOT_FOUND   # set dynamically
        return {"error": "not found"}
    response.headers["X-Custom"] = "value"                  # set a custom header
    return item
```

`Response` पैरामीटर इंजेक्ट करने से आप **सशर्त रूप से** रनटाइम पर स्टेटस कोड और हेडर सेट कर सकते हैं।

## त्रुटियां: HTTPException उठाएं

```python
from fastapi import HTTPException

@app.get("/items/{id}")
def get_item(id: int):
    item = db.get(id)
    if not item:
        raise HTTPException(status_code=404, detail="Item not found",
                            headers={"X-Error": "NotFound"})   # status + detail + headers
    return item
```

त्रुटि प्रतिक्रियाओं के लिए, `raise HTTPException(...)` प्रणालीगत तरीका है — यह स्थिति, JSON `detail` संदेश, और वैकल्पिक हेडर सेट करता है।

## कस्टम Response सीधे लौटाएं

```python
from fastapi.responses import JSONResponse
return JSONResponse(content={...}, status_code=202, headers={"X-Custom": "v"})
```

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

उचित स्टेटस कोड और हेडर सही, अच्छी तरह से व्यवहार करने वाली REST API बनाने के लिए आवश्यक हैं — क्लाइंट और उपकरण मानक HTTP शब्दार्थ पर निर्भर करते हैं (बनाए गए के लिए 201, नहीं मिला के लिए 404, कोई सामग्री नहीं के लिए 204, आदि), इसलिए सही कोड लौटाना एक गुणवत्तापूर्ण API अनुबंध का हिस्सा है।

FastAPI आपको स्वच्छ नियंत्रण देता है: सामान्य मामले के लिए रूट पर डिफ़ॉल्ट `status_code`, गतिशील कोड/हेडर के लिए इंजेक्टेबल `Response` ऑब्जेक्ट, और उचित स्थिति और JSON विवरण के साथ त्रुटियों को संकेत देने का प्रणालीगत तरीका `HTTPException`।

इन तंत्रों को समझना — और स्पष्टता के लिए `status` स्थिरांकों का उपयोग करना — API बनाने के लिए दैनिक ज्ञान है जो सही तरीके से व्यवहार करते हैं और अपने उपभोक्ताओं के साथ स्पष्ट रूप से संवाद करते हैं।