คุณจะรับเนื้อหาคำขอ JSON ได้อย่างไร

Question

Accepted Answer

ในการรับเนื้อหาคำขอ JSON ใน FastAPI ให้ประกาศพารามิเตอร์ฟังก์ชันที่พิมพ์เป็น **โมเดล Pydantic** FastAPI อ่านเนื้อหา แยกวิश์เลษ JSON ตรวจสอบกับโมเดล และให้คุณได้รับวัตถุที่พิมพ์ — โดยอัตโนมัติ

## รูปแบบ

```python
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float
    description: str | None = None      # optional field

@app.post("/items")
def create_item(item: Item):             # `item: Item` → read & validate the JSON body
    # `item` is a fully-validated Item object here
    return {"name": item.name, "total": item.price * 1.1}
```

```json
// request body the client sends:
{ "name": "Phone", "price": 999.0 }
```

การประกาศ `item: Item` บอก FastAPI ให้อ่านเนื้อหาคำขอเป็น JSON แยกวิศเลษเป็น `Item` และ **ตรวจสอบ** — ฟังก์ชันของคุณจะได้รับวัตถุที่พิมพ์ และถูกต้อง ข้อมูลเข้าที่ไม่ถูกต้องจะถูกปฏิเสธโดยอัตโนมัติ:

```json
// POST { "name": "Phone" }  (missing price) → automatic 422:
{ "detail": [{ "loc": ["body", "price"], "msg": "field required" }] }
```

## เนื้อหา + เส้นทาง + คำถามรวมกัน

```python
@app.put("/items/{item_id}")
def update(item_id: int, item: Item, notify: bool = False):
    # item_id = path param, item = JSON body (Pydantic model), notify = query param
    # FastAPI distinguishes them by type/location automatically
```

FastAPI ส่งเส้นทางพารามิเตอร์อย่างฉลาด: ตัวจำหน้าเส้นทาง → พารามิเตอร์เส้นทาง, โมเดล Pydantic → เนื้อหาคำขอ, พารามิเตอร์ที่พิมพ์แบบง่าย → พารามิเตอร์คำถาม

## พารามิเตอร์เนื้อหาหลายตัว / การอัปเดตบางส่วน

```python
@app.patch("/items/{id}")
def patch(id: int, item: ItemUpdate):       # use a model with all-optional fields for PATCH
    update_data = item.model_dump(exclude_unset=True)   # only fields the client sent
```

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

การรับและตรวจสอบเนื้อหาคำขอเป็นสิ่งจำเป็น — เกือบทุกตัว API ที่สร้างหรืออัปเดตข้อมูลจำเป็นต้องใช้ และ FastAPI ทำให้มันสะอาดอย่างมาก: การประกาศพารามิเตอร์โมเดล Pydantic ให้คุณได้รับการแยกวิศเลษ JSON โดยอัตโนมัติ **ตรวจสอบ** ที่สมบูรณ์ (มีข้อผิดพลาดในระดับฟิลด์ที่ชัดเจน 422) และวัตถุที่พิมพ์ โดยกำจัดการแยกวิศเลษและตรวจสอบแบบด้วยตนเองที่น่าเบื่อหน่ายและมีแนวโน้มที่เกิดข้อผิดพลาดซึ่งกรอบการทำงานอื่นต้องการ

การตรวจสอบยังเป็นประโยชน์ที่สำคัญของ **ความปลอดภัย/ความมั่นคง** — ข้อมูลเข้าที่มีรูปแบบไม่ถูกต้องจะถูกปฏิเสธก่อนที่จะไปถึงลอจิกของคุณ

การทำความเข้าใจวิธีการกำหนดโมเดลเนื้อหา วิธีที่ FastAPI แยกความแตกต่างระหว่างเนื้อหากับพารามิเตอร์เส้นทาง/คำถามโดยอัตโนมัติ และรูปแบบเช่น `exclude_unset` สำหรับการอัปเดตบางส่วนเป็นความรู้พื้นฐานทุกวันสำหรับการสร้างจุดสิ้นสุดการเขียน