Kaip gauti JSON užklausos kūną?

Question

Accepted Answer

Norėdami gauti JSON užklausos kūną FastAPI, deklaruojate funkcijos parametrą, kuris turi **Pydantic modelio** tipą. FastAPI nuskaito kūną, išanalizuoja JSON, patvirtina pagal modelį ir perduoda jums tipizuotą objektą — automatiškai.

## Kodėl tai svarbu

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

Deklaravus `item: Item`, nurodote FastAPI skaityti užklausos kūną kaip JSON, išanalizuoti jį į `Item` ir **patvirtinti** — jūsų funkcija gauna tipizuotą, validų objektą. Bloga įvestis automatiškai atmesta:

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

## Body + path + query kartu

```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 protingai maršrutizuoja parametrus: kelio viettūklis → kelio parametras, Pydantic modelis → užklausos kūnas, paprastai tipizuotas parametras → query parametras.

## Keli body parametrai / daliniai atnaujinimai

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

## Kodėl tai svarbu

Užklausos kūno gavimas ir patvirtinimas yra būtinas — beveik visas API, kurie kuria arba atnaujina duomenis, to reikalauja, o FastAPI tai daro nuostabiai švariai: deklaravus Pydantic modelio parametrą, gausite automatinį JSON analizavimą, visišką **patvirtinimą** (su aiškiomis lauko lygio 422 klaidomis) ir tipizuotą objektą, panaikinant nuobodų, klaidoms jautrų rankinį analizavimą ir patvirtinimą, kurio reikalauja kiti karkasai.

Patvirtinimas taip pat yra esminė **saugos/patikimumo** nauda — neteisingai suformuota įvestis yra atmesta prieš pasiekiant jūsų logiką.

Supratimas, kaip apibrėžti body modelį, kaip FastAPI automatiškai atskiria body nuo path/query parametrų ir šablonai, tokie kaip `exclude_unset` daliniam atnaujinimui, yra esminės kasdieninės žinios kuriant bet kokią rašymo pabaigą.