আপনি কীভাবে স্ট্যাটাস কোড এবং হেডার সেট করেন?

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 তৈরির জন্য প্রতিদিনের জ্ঞান যা সঠিকভাবে আচরণ করে এবং তাদের ভোক্তাদের সাথে স্পষ্টভাবে যোগাযোগ করে।