पाठ 2 / 24

रिसोर्स और URI

एंडपॉइंट का नामकरण संज्ञा के आधार पर, क्रिया के नहीं।

रिसोर्स एक संज्ञा है

एक रिसोर्स कोई भी चीज़ है जिसे आप नाम और एड्रेस दे सकते हैं — एक यूज़र, एक ऑर्डर, ऑर्डर का एक कलेक्शन। URI यह बताता है कि आप किस बारे में बात कर रहे हैं; HTTP मेथड बताता है कि उसके साथ क्या करना है।

नामकरण परंपराएँ

कलेक्शन के लिए बहुवचन संज्ञा, लोअरकेस-हाइफ़न उपयोग करें, और स्वामित्व दिखाने के लिए रिसोर्स को नेस्ट करें। क्रिया से बचें — मेथड पहले से ही क्रिया है।

GET  /orders               # good: plural noun
GET  /orders/482           # a single order
GET  /users/9/orders       # orders owned by user 9

GET  /getAllOrders         # bad: verb in the path
POST /order/create         # bad: redundant verb

नेस्टिंग उथली रखें

/users/9/orders/482/items पहले से ही बहुत है। दो स्तरों से आगे, क्वेरी फ़िल्टर वाला फ़्लैट URI पसंद करें — /order-items?orderId=482 — इसे रूट और कैश करना आसान है।