آپ JSON ریکویسٹ باڈی کو کیسے حاصل کرتے ہیں؟

Question

Accepted Answer

FastAPI میں JSON ریکویسٹ باڈی حاصل کرنے کے لیے، آپ ایک فنکشن پیرامیٹر کو **Pydantic ماڈل** کے طور پر declare کرتے ہیں۔ FastAPI باڈی کو پڑھتا ہے، JSON کو parse کرتا ہے، اسے ماڈل کے خلاف validate کرتا ہے، اور آپ کو ایک typed object فراہم کرتا ہے — خودکار طور پر۔

## نمونہ

```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` کو declare کرنا FastAPI کو بتاتا ہے کہ ریکویسٹ باڈی کو JSON کے طور پر پڑھو، اسے `Item` میں parse کرو، اور **validate** کرو — آپ کا فنکشن ایک typed، valid object حاصل کرتا ہے۔ غلط input خودکار طور پر مسترد کیا جاتا ہے:

```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 ذہانت سے پیرامیٹرز کو route کرتا ہے: ایک path placeholder → path param، ایک Pydantic ماڈل → ریکویسٹ باڈی، ایک سادہ-typed پیرامیٹر → query param۔

## متعدد باڈی پیرامیٹرز / جزوی اپڈیٹس

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

## یہ کیوں اہم ہے

ریکویسٹ باڈیز کو حاصل کرنا اور validate کرنا ضروری ہے — تقریباً ہر API جو ڈیٹا بناتا یا اپڈیٹ کرتا ہے اسے اس کی ضرورت ہے، اور FastAPI اسے بہت صاف طریقے سے کرتا ہے: ایک Pydantic-ماڈل پیرامیٹر declare کرنے سے آپ کو خودکار JSON parsing، مکمل **validation** (واضح field-level 422 errors کے ساتھ)، اور ایک typed object ملتا ہے، جو دوسری frameworks میں درکار تکلیف دہ، غلط سے رہنے والی دستی parsing اور validation کو ختم کرتا ہے۔

Validation بھی ایک اہم **security/robustness** فائدہ ہے — غلط input آپ کی logic تک پہنچنے سے پہلے مسترد کر دیا جاتا ہے۔

باڈی ماڈل کو define کرنا، FastAPI جسطرح خودکار طور پر body کو path/query پیرامیٹرز سے الگ کرتا ہے، اور `exclude_unset` جیسے partial updates کے نمونے سمجھنا کسی بھی write endpoint بنانے کے لیے بنیادی روزمرہ کا علم ہے۔