آپ status codes اور headers کو کیسے سیٹ کرتے ہیں؟

Question

Accepted Answer

FastAPI ڈیفالٹ طور پر `200 OK` واپس کرتا ہے، لیکن آپ **status code** (decorator یا response object کے ذریعے) اور **headers** کو کنٹرول کر سکتے ہیں جب آپ کو مختلف رویہ درکار ہو — یہ صحیح REST semantics کے لیے اہم ہے۔

## route پر ڈیفالٹ status code سیٹ کریں

```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` decorator parameter ڈیفالٹ کامیابی status سیٹ کرتا ہے۔ `status` constants استعمال کرنا (مثال کے طور پر `status.HTTP_201_CREATED`) جادو کے نمبروں سے زیادہ واضح ہے۔ صحیح codes اہم ہیں: `201` بنایا گیا ہے، `204` کوئی content نہیں ہے، وغیرہ۔

## Response object کے ذریعے متحرک status codes اور headers

```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` parameter inject کرنا آپ کو status code اور headers کو **مشروط طور پر** runtime پر سیٹ کرنے دیتا ہے۔

## Errors: HTTPException raise کریں

```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
```

Error responses کے لیے، `raise HTTPException(...)` idiomatic طریقہ ہے — یہ status، ایک JSON `detail` پیغام، اور اختیاری headers سیٹ کرتا ہے۔

## براہ راست custom Response واپس کریں

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

## یہ کیوں اہم ہے

صحیح status codes اور headers صحیح، اچھی طریقے سے سلوک کرنے والے REST APIs بنانے کے لیے ضروری ہیں — clients اور tools معیاری HTTP semantics پر منحصر ہیں (بنایا گیا ہے تو 201، نہیں ملا تو 404، کوئی content نہیں تو 204، وغیرہ)، تو صحیح code واپس کرنا ایک معیاری API معاہدے کا حصہ ہے۔

FastAPI صاف ستھرا کنٹرول فراہم کرتا ہے: عام صورت کے لیے route پر ڈیفالٹ `status_code`، متحرک codes/headers کے لیے injectable `Response` object، اور errors کو مناسب status اور JSON detail کے ساتھ signal کرنے کا idiomatic طریقہ `HTTPException`۔

ان mechanisms کو سمجھنا — اور وضاحت کے لیے `status` constants استعمال کرنا — APIs بنانے کے لیے روز مرہ کا علم ہے جو صحیح طریقے سے سلوک کریں اور اپنے consumers کے ساتھ واضح طریقے سے communicate کریں۔