Kuinka vastaanotat JSON-pyyntökappaleen?

Question

Accepted Answer

Vastaanottaaksesi JSON-pyyntökappaleen FastAPI:ssa, ilmoitat funktion parametrin, joka on tyypitetty **Pydantic-malliksi**. FastAPI lukee kappaleen, jäsentää JSON:n, validoi sen mallia vastaan ja välittää sinulle tyypitetyn objektin — automaattisesti.

## Kuvio

```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` -ilmoitus kertoo FastAPI:lle, että se lukee pyyntökappaleen JSON:ksi, jäsentää sen `Item`:iksi ja **validoi** sen — funktiosi vastaanottaa tyypitetyn, kelvollisen objektin. Virheellinen syöte hylätään automaattisesti:

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

## Kappale + polku + kysely yhdessä

```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 reitittää parametrit älykkäästi: polun paikanpidin → polun parametri, Pydantic-malli → pyyntökappale, yksinkertaisesti tyypitetty parametri → kyselyparametri.

## Useat kappaleparametrit / osittaiset päivitykset

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

## Miksi tämä on tärkeää

Pyyntökappaleiden vastaanotto ja validointi on olennaista — lähes jokainen API, joka luo tai päivittää tietoja, tarvitsee sitä, ja FastAPI tekee siitä huomattavan puhtaan: Pydantic-malli-parametrin ilmoittaminen antaa sinulle automaattisen JSON-jäsentämisen, täydellisen **validoinnin** (selkeiden kenttätason 422-virheiden kanssa) ja tyypitetyn objektin, mikä eliminoi muiden kehysten vaatiman väsyttävän, virheille altiin manuaalisen jäsentämisen ja validoinnin.

Validointi on myös keskeinen **turvallisuus/vahvuus**-etu — virheellisesti muotoiltu syöte hylätään ennen kuin se saavuttaa logiikkasi.

Kappalmallin määrittelyn, FastAPI:n automaattisen kappale-/polku-kyselyparametrien erottelun ja osittaisiin päivityksiin soveltuvien kuvioiden (kuten `exclude_unset`) ymmärtäminen on perustavanlaatuista päivittäistä tietoa minkä tahansa kirjoituspäätepisteiden rakentamiseen.