તમે સ્ટેટસ કોડ્સ અને હેડર્સ કેવી રીતે સેટ કરો છો?

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 બનાવવા માટે દૈનિક જ્ઞાન છે જે સાચી રીતે વર્તે છે અને તેમના ગ્રાહકો સાથે સ્પષ્ટતાથી સંચાર કરે છે।