REST API मा resource URI हरू कसरी नामकरण र संरचित गर्नुपर्छ?

Question

IT Interview Practice · Accepted Answer

एउटा resource URI कुनै action होइन, **एउटा "थोक" तर्फको noun-आधारित path** जस्तो पढिनुपर्छ। HTTP method ले verb पहिल्यै दिन्छ, त्यसैले URI ले resource लाई स्पष्ट र एकरूप रूपमा पहिचान मात्र गर्नुपर्छ।

## मुख्य convention हरू

- **Verb होइन, noun प्रयोग गर्नुहोस्।** `GET /users/42` — `GET /getUser?id=42` होइन। Method (`GET`) नै verb हो।
- **Collection का लागि bahuvachan noun प्रयोग गर्नुहोस्।** `/users` collection हो; `/users/42` एउटा सदस्य हो। सबैतिर bahuvachan राख्नाले यो अनुमानयोग्य रहन्छ।
- **सम्बन्धहरूलाई nesting द्वारा model गर्नुहोस्** — तर छिपछिपे। `/users/42/orders` = "user 42 का order हरू"।
- **`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 मा नमिल्ने action का लागि (जस्तै "send email"), controller-शैलीको sub-resource स्वीकार्य छ: `POST /users/42/verify-email`।

## यो किन महत्त्वपूर्ण छ

एकरूप नामकरणले एउटा API लाई सहज महसुस गराउँछ — `/users` र `/users/42` देखेको developer ले doc नपढी `/products` र `/products/99` सही अनुमान गर्न सक्छ। Interviewer हरूले यो तपाईं **RPC call** (`/doThisThing`) होइन **resource** मा (REST मानसिकता) सोच्नुहुन्छ कि भनेर मापन गर्न प्रयोग गर्छन्। सबैभन्दा सामान्य anti-pattern हरू — path मा verb, असंगत bahuvachan/ekvachan, र गहिरो nested URL — सबैले API लाई सिक्न र कायम राख्न गाह्रो बनाउँछन्, र REST को uniform-interface constraint आत्मसात नगरेको developer को सङ्केत दिन्छन्। राम्रो URI design ले चिन्ताहरूलाई पनि छुट्याइराख्छ: पहिचान path मा, filtering र pagination query string मा, जसले caching र routing सफा राख्छ।

मुख्य convention हरू

एउटा एकरूप पदानुक्रम

उदाहरणहरू

यो किन महत्त्वपूर्ण छ

सम्बन्धित प्रश्नहरू