Hvordan mottar du en JSON-forespørselstekst?

Question

Accepted Answer

For å motta en JSON-forespørselstekst i FastAPI, deklarerer du en funksjonsparameter skrevet som en **Pydantic-modell**. FastAPI leser teksten, parser JSON, validerer den mot modellen, og gir deg et skrevet objekt — automatisk.

## Mønsteret

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

Å deklarere `item: Item` forteller FastAPI å lese forespørselsteksten som JSON, parse den til en `Item`, og **validere** den — funksjonen din mottar et skrevet, gyldig objekt. Dårlig inndata avvises automatisk:

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

## Tekst + bane + spørring sammen

```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 ruter parametere intelligent: en baneplassholder → baneparameter, en Pydantic-modell → forespørselstekst, en enkelt skrevet parameter → spørringsparameter.

## Flere tekstparametere / delvise oppdateringer

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

## Hvorfor det er viktig

Å motta og validere forespørselstekster er essensielt — nesten alle API-er som oppretter eller oppdaterer data trenger det, og FastAPI gjør det bemerkelsesverd rent: å deklarere en Pydantic-modellparameter gir deg automatisk JSON-parsing, full **validering** (med klare feilmeldinger på feltnivå 422), og et skrevet objekt, noe som eliminerer det kjedelige, feilprompt manuelle parsing og validering som andre rammeverk krever.

Valideringen er også en viktig **sikkerhet/robusthet**-fordel — dårlig utformet inndata avvises før den når logikken din.

Å forstå hvordan du definerer en tekstmodell, hvordan FastAPI automatisk skiller tekst fra bane-/spørringparametere, og mønstre som `exclude_unset` for delvise oppdateringer er fundamental dagligkunnskap for å bygge enhver skriveendepunkt.