Bagaimana Anda menerima badan permintaan JSON?

Question

Accepted Answer

Untuk menerima badan permintaan JSON di FastAPI, Anda mendeklarasikan parameter fungsi yang diketik sebagai **model Pydantic**. FastAPI membaca badan, mengurai JSON, memvalidasinya terhadap model, dan menyampaikan kepada Anda objek yang diketik — secara otomatis.

## Pola

```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 }
```

Mendeklarasikan `item: Item` memberi tahu FastAPI untuk membaca badan permintaan sebagai JSON, menguraikannya menjadi `Item`, dan **memvalidasi** — fungsi Anda menerima objek yang diketik dan valid. Masukan buruk ditolak secara otomatis:

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

## Badan + jalur + kueri bersama-sama

```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 secara cerdas merutekan parameter: placeholder jalur → parameter jalur, model Pydantic → badan permintaan, parameter yang diketik sederhana → parameter kueri.

## Beberapa parameter badan / pembaruan parsial

```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
```

## Mengapa ini penting

Menerima dan memvalidasi badan permintaan sangat penting — hampir setiap API yang membuat atau memperbarui data membutuhkannya, dan FastAPI membuatnya luar biasa bersih: mendeklarasikan parameter model Pydantic memberi Anda penguraian JSON otomatis, **validasi** lengkap (dengan kesalahan 422 tingkat bidang yang jelas), dan objek yang diketik, menghilangkan penguraian manual yang membosankan dan rentan kesalahan serta validasi yang diperlukan kerangka kerja lain.

Validasi juga merupakan manfaat **keamanan/ketahanan** utama — masukan yang salah bentuk ditolak sebelum mencapai logika Anda.

Memahami cara mendefinisikan model badan, bagaimana FastAPI secara otomatis membedakan badan dari parameter jalur/kueri, dan pola seperti `exclude_unset` untuk pembaruan parsial adalah pengetahuan sehari-hari fundamental untuk membangun titik akhir tulis apa pun.