คุณตั้งค่ารหัสสถานะและ headers อย่างไร

Question

Accepted Answer

FastAPI ส่งคืน `200 OK` โดยค่าเริ่มต้น แต่คุณสามารถควบคุม **รหัสสถานะ** (ผ่านทาง decorator หรือ response object) และ **headers** เมื่อคุณต้องการพฤติกรรมที่แตกต่างกัน — สิ่งนี้มีความสำคัญต่อ REST semantics ที่ถูกต้อง

## ตั้งค่ารหัสสถานะเริ่มต้นบนเส้นทาง

```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` ของ decorator กำหนดสถานะความสำเร็จเริ่มต้น การใช้ค่าคงที่ `status` (เช่น `status.HTTP_201_CREATED`) ชัดเจนกว่าตัวเลขที่มีเวทมนตร์ รหัสที่ถูกต้องมีความสำคัญ: `201` สำหรับสร้าง `204` สำหรับไม่มีเนื้อหา ฯลฯ

## รหัสสถานะแบบไดนามิกและ headers ผ่าน Response object

```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` parameter ช่วยให้คุณตั้งค่ารหัสสถานะและ headers **ตามเงื่อนไข** ที่เวลาการทำงาน

## ข้อผิดพลาด: raise 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` และ headers ที่เป็นตัวเลือก

## ส่งคืน Response แบบกำหนดเอง โดยตรง

```python
from fastapi.responses import JSONResponse
return JSONResponse(content={...}, status_code=202, headers={"X-Custom": "v"})
```

## เหตุใดจึงสำคัญ

รหัสสถานะและ headers ที่ถูกต้องมีความจำเป็นสำหรับการสร้าง REST API ที่ถูกต้องและมีพฤติกรรมที่ดี — ไคลเอนต์และเครื่องมือต่างๆ อาศัย HTTP semantics มาตรฐาน (201 สำหรับสร้าง 404 สำหรับไม่พบ 204 สำหรับไม่มีเนื้อหา ฯลฯ) ดังนั้นการส่งคืนรหัสที่ถูกต้องจึงเป็นส่วนหนึ่งของสัญญา API ที่มีคุณภาพ

FastAPI ให้การควบคุมที่สะอาด: `status_code` เริ่มต้นบนเส้นทางสำหรับกรณีทั่วไป response object ที่สามารถฉีดได้สำหรับรหัส/headers แบบไดนามิก และ `HTTPException` เป็นวิธีธรรมชาติในการส่งสัญญาณข้อผิดพลาดด้วยสถานะและรายละเอียด JSON ที่เหมาะสม

การทำความเข้าใจกลไก เหล่านี้ — และการใช้ค่าคงที่ `status` เพื่อความชัดเจน — เป็นความรู้ในชีวิตประจำวันสำหรับการสร้าง API ที่ทำงานอย่างถูกต้องและสื่อสารอย่างชัดเจนกับผู้บริโภค