நீங்கள் நிலைக் குறிப்புகள் மற்றும் தலைப்புகளை எவ்வாறு அமைக்கிறீர்கள்?

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 களை உருவாக்குவதற்கான அன்றாட அறிவாகும்.