คุณจัดการ error และ raise HTTP exceptions ได้อย่างไร?

Question

Accepted Answer

FastAPI จัดการ error โดยการ **raise exceptions** ที่มันแปลงเป็น HTTP responses ที่เหมาะสม `HTTPException` ครอบคลุมกรณีส่วนใหญ่ ส่วน custom exception handlers ช่วยให้คุณควบคุมการจัดรูปแบบ error แบบ global ได้

## การ 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")   # → 404 JSON response
    if not item.is_public:
        raise HTTPException(status_code=403, detail="Forbidden")
    return item
```

`raise HTTPException(status_code=..., detail=...)` เป็นวิธีที่เป็นสำนวนในการ return error — FastAPI จะสร้าง JSON response `{"detail": "..."}` พร้อม status ที่กำหนด ค่า `detail` สามารถเป็นค่าใด ๆ ที่ serialize เป็น JSON ได้ (string, dict, list)

## validation errors เกิดขึ้นอัตโนมัติ (422)

```text
When request data fails Pydantic validation, FastAPI AUTOMATICALLY returns a 422
with a structured list of exactly which fields are wrong — you write nothing.
```

## custom exception handlers (การจัดรูปแบบแบบ global)

```python
from fastapi import Request
from fastapi.responses import JSONResponse

class ItemNotFound(Exception):
    def __init__(self, item_id: int): self.item_id = item_id

@app.exception_handler(ItemNotFound)         # handle a custom exception type globally
def handle_not_found(request: Request, exc: ItemNotFound):
    return JSONResponse(status_code=404, content={"error": f"Item {exc.item_id} not found"})

@app.get("/items/{id}")
def get(id: int):
    raise ItemNotFound(id)        # raise your domain exception; the handler formats it
```

custom exception handlers ช่วยให้คุณ map exceptions (ของ domain) ของคุณเองไปยัง responses ได้ ทำให้การจัดรูปแบบ error เป็นศูนย์กลางและทำให้โค้ด handler สะอาด

## การ override default handlers

```python
from fastapi.exceptions import RequestValidationError

@app.exception_handler(RequestValidationError)   # customize the 422 validation-error format
def validation_handler(request, exc):
    return JSONResponse(status_code=422, content={"errors": exc.errors()})
```

## ทำไมจึงสำคัญ

การจัดการ error ที่เหมาะสมเป็นสิ่งจำเป็นสำหรับการสร้าง API ที่เชื่อถือได้และเป็นมืออาชีพ และแนวทางของ FastAPI นั้นสะอาดและสม่ำเสมอ

`HTTPException` ที่เป็นสำนวนทำให้ง่ายต่อการ return error responses ที่ถูกต้องพร้อม status codes และข้อความที่เหมาะสม — เป็นพื้นฐานสำหรับทุก endpoint ที่อาจล้มเหลว (not found, forbidden, สถานะที่ไม่ถูกต้อง)

ที่มีคุณค่าเท่ากันคือ **validation errors ถูกจัดการโดยอัตโนมัติ** (ความล้มเหลวของ Pydantic สร้าง response 422 ที่มีโครงสร้างโดยที่คุณไม่ต้องเขียนโค้ด) และ **custom exception handlers** ช่วยให้คุณ map domain exceptions ของคุณเองไปยัง responses และบังคับใช้รูปแบบ error ที่สม่ำเสมอทั่วทั้ง API — ปรับปรุงทั้งความง่ายในการดูแล (logic error แบบรวมศูนย์) และประสบการณ์ของ client (รูปแบบ error ที่คาดเดาได้)

การเข้าใจ `HTTPException`, validation errors อัตโนมัติ และ custom handlers ครอบคลุมขอบเขตในทางปฏิบัติของการจัดการ error ทำให้เป็นความรู้สำคัญในการสร้าง API ที่แข็งแกร่ง