ਤੁਸੀਂ ਸਟੇਟਸ ਕੋਡ ਅਤੇ ਹੈੱਡਰ ਕਿਵੇਂ ਸੈੱਟ ਕਰਦੇ ਹੋ?

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` ਆਬਜੈਕਟ, ਅਤੇ `HTTPException` ਗਲਤੀਆਂ ਨੂੰ ਸਹੀ ਸਟੇਟਸ ਅਤੇ JSON ਵੇਰਵੇ ਦੇ ਨਾਲ ਸੰਕੇਤ ਕਰਨ ਦਾ ਮੌਖਿਕ ਤਰੀਕਾ।

ਇਨ੍ਹਾਂ ਆਲਿਆਵਾਂ ਨੂੰ ਸਮਝਣਾ — ਅਤੇ ਸਪਸ਼ਟਤਾ ਲਈ `status` ਸਥਿਰਾਂਕ ਦੀ ਵਰਤੋਂ ਕਰਨਾ — API ਬਣਾਉਣ ਲਈ ਰੋਜ਼ਾਨਾ ਦਾ ਗਿਆਨ ਹੈ ਜੋ ਸਹੀ ਤਰ੍ਹਾਂ ਵਿਵਹਾਰ ਕਰਦੇ ਹਨ ਅਤੇ ਆਪਣੇ ਖਪਤਕਾਰਾਂ ਨਾਲ ਸਪਸ਼ਟ ਤਰ੍ਹਾਂ ਸੰਵਾਦ ਕਰਦੇ ਹਨ।