Conas a fhaigheann tú corp iarratas JSON?

Question

Accepted Answer

Chun corp iarratas JSON a fháil i FastAPI, déanann tú paraiméadar feidhme a dhearbhú atá clóscríofa mar **mhúnla Pydantic**. Léann FastAPI an corp, parsálann sé an JSON, bailíonn sé í bhfrinne an mhúnla, agus tugann sé rud clóscríofa duit go huathoibríoch.

## An patrún

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

A bhreith `item: Item` a insíonn do FastAPI a léamh an corp iarratas mar JSON, a pharsáil ina `Item`, agus a **bhailíonn** — faigheann do fheidhm réad clóscríofa, bailí. Dhiúltaítear do ionchur olc go huathoibríoch:

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

## Body + path + query le chéile

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

Ceartaíonn FastAPI go tuisceanach paraiméadair: plásóideoir cabhair → paraiméadar cabhair, múnla Pydantic → corp an iarratas, paraiméadar shimplí-clóscríofa → paraiméadar ceiste.

## Paraiméadair iomadúla body / nuashonruithe páirteach

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

## Cén fáth a bhfuil tábhacht air

Tá glacadh agus bailíochtú na gcomhartha iarratas riachtanach — gá go bhfuil API a bhformhór beagnach a chruthaíonn nó a nuashonraíonn sonraí, agus déanann FastAPI geal atá iontach geal: a dhearbhú paramaiméadar múnla Pydantic tugann duit parseáil JSON uathoibríoch, fíorbhailíochtú **validation** (le soiléir-réimse 422 earráidí), agus réad clóscríofa, ag baint an chuid bhuartha, earráid-prone parsáil láimhe agus bailíochtú a éilíonn creat eile.

Tá an bhailíochtú ina bhuntáiste príomha freisin i dtéarmaí **slándáil/robustness** — dhiúltaítear do ionchur mídhlúth sula sroicheann sé do dhéantúsóireacht.

Tuiscint a bheith agat ar conas múnla corp a shainiú, conas a dhéanann FastAPI idirdhealú go huathoibríoch idir corp agus paraiméadair cabhair/ceiste, agus patrúin ar nós `exclude_unset` le haghaidh nuashonruithe páirteach is eolas lárnach laethúil a bhíonn ann chun aon fheidhm scríofa a thógáil.