आप स्टेटस कोड आणि हेडर्स कसे सेट करता?

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` पॅरामीटरचे इंजेक्शन आपल्याला रनटाइमवर **सशर्त** स्टेटस कोड आणि हेडर्स सेट करण्यास अनुमती देते.

## त्रुटी: raise 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` संदेश आणि वैकल्पिक हेडर्स सेट करतो.

## सरळ कस्टम रिस्पॉन्स परत करणे

```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` ऑब्जेक्ट, आणि `HTTPException` योग्य स्टेटस आणि JSON विवरणांसह त्रुटी सूचित करण्याचा वाक्यविन्यास मार्ग.

ही यंत्रणा समजणे — आणि स्पष्टतेसाठी `status` स्थिरांक वापरणे — योग्य व्यवहार करणारे आणि त्यांच्या ग्राहकांशी स्पष्टपणे संवाद करणारे API तयार करण्यासाठी रोजचे ज्ञान आहे.