کسی REST API میں resource URIs کو کیسے نام اور ساخت دینی چاہیے؟

Question

IT Interview Practice · Accepted Answer

ایک resource URI کو کسی **شے تک اسم پر مبنی راستے** کی طرح پڑھا جانا چاہیے، نہ کہ کسی عمل کی طرح۔ HTTP method پہلے ہی فعل (verb) فراہم کر دیتا ہے، اس لیے URI کو صرف resource کی واضح اور مستقل شناخت کرنے کی ضرورت ہے۔

## بنیادی اصول

- **اسم استعمال کریں، افعال نہیں۔** `GET /users/42` — نہ کہ `GET /getUser?id=42`۔ method (`GET`) ہی فعل ہے۔
- **collections کے لیے جمع اسم استعمال کریں۔** `/users` collection ہے؛ `/users/42` ایک رکن ہے۔ ہر جگہ جمع رکھنا اسے قابلِ پیش گوئی رکھتا ہے۔
- **تعلقات کو nesting سے ماڈل کریں** — لیکن اتھلے طور پر۔ `/users/42/orders` = "user 42 سے تعلق رکھنے والے orders"۔
- **`kebab-case`، lowercase استعمال کریں۔** `/blog-posts`، نہ کہ `/blogPosts` یا `/Blog_Posts`۔
- **filtering، sorting، اور paging کو query string میں رکھیں**، path میں نہیں: `/users?role=admin&sort=-created_at`۔

## ایک مستقل درجہ بندی

```text
/users                     collection of users
/users/42                  a single user
/users/42/orders           orders belonging to user 42 (sub-collection)
/users/42/orders/1001      a specific order of that user
/orders/1001               same order, addressable at top level too
```

## مثالیں

```http
GET /users/42/orders?status=shipped&sort=-created_at&page=2 HTTP/1.1
Accept: application/json
```

ایک یا دو سطحوں سے زیادہ گہری nesting سے بچیں — `/users/42/orders/1001/items/5/reviews` نازک بن جاتا ہے۔ جب کسی order کا اپنا ID ہو، تو `/orders/1001` کو ترجیح دیں۔ ان اعمال کے لیے جو CRUD میں فٹ نہیں آتے (مثلاً "email بھیجنا")، ایک controller طرز کا sub-resource قابلِ قبول ہے: `POST /users/42/verify-email`۔

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

مستقل نام گذاری ہی وہ چیز ہے جو کسی API کو بدیہی محسوس کراتی ہے — ایک ڈویلپر جس نے `/users` اور `/users/42` دیکھا ہو وہ بغیر docs پڑھے `/products` اور `/products/99` کا درست اندازہ لگا سکتا ہے۔ انٹرویو لینے والے اسے یہ ناپنے کے لیے استعمال کرتے ہیں کہ آیا آپ **RPC calls** (`/doThisThing`) کے بجائے **resources** میں سوچتے ہیں (REST ذہنیت)۔ سب سے عام anti-patterns — path میں افعال، غیر مستقل جمع سازی، اور گہرائی سے nested URLs — سبھی کسی API کو سیکھنے اور برقرار رکھنے میں مشکل تر بناتے ہیں، اور یہ ایک ایسے ڈویلپر کا اشارہ دیتے ہیں جس نے REST کی uniform-interface پابندی کو اندر تک نہیں اتارا۔ اچھا URI ڈیزائن مسائل کو الگ بھی رکھتا ہے: شناخت path میں، filtering اور pagination query string میں، جو caching اور routing کو صاف رکھتا ہے۔

بنیادی اصول

ایک مستقل درجہ بندی

مثالیں

یہ کیوں اہم ہے

متعلقہ سوالات