JSONリクエストボディを受け取るにはどうしますか?

Question

Accepted Answer

FastAPIでJSONリクエストボディを受け取るには、**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" }] }
```

## Body + path + queryを一緒に

```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モデル → リクエストボディ、シンプルな型付けパラメータ → クエリパラメータ。

## 複数のbodyパラメータ / 部分的なアップデート

```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エラーが明確)、型付けされたオブジェクトが得られ、他のフレームワークが必要とする退屈でエラーが起きやすい手動解析と検証を排除します。

検証は**セキュリティ/堅牢性**の重要な利点でもあります — 不正な入力はロジックに到達する前に拒否されます。

bodyモデルの定義方法、FastAPIがbodyとpath/queryパラメータを自動的に区別する方法、部分的なアップデート用の`exclude_unset`などのパターンを理解することは、任意のwriteエンドポイントを構築するための基本的な日常的な知識です。