మీరు స్టేటస్ కోడ్‌లు మరియు హెడర్‌లను ఎలా సెట్ చేయండి?

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 లను నిర్మించడానికి రోజువారీ జ్ఞానం.