# फ़ील्ड नामकरण परंपराएँ — रेस्ट एपीआई डिज़ाइन

Source: https://www.geekswithgeeks.com/hi/restapi/api-field-naming

> एक केसिंग चुनना और पूरे API में उस पर टिके रहना।

## camelCase या snake_case — बस सुसंगत रहें

JSON API आमतौर पर `camelCase` (JavaScript से मेल खाता है) या `snake_case` (कई बैकएंड भाषाओं और SQL कॉलम से मेल खाता है) उपयोग करते हैं। दोनों ठीक हैं; एक ही पेलोड में दोनों मिलाना क्लाइंट को भ्रमित करता है।

## इकाइयों और टाइप में स्पष्ट रहें

फ़ील्ड का नाम ऐसा रखें कि उनका अर्थ स्पष्ट हो: `price` नहीं `priceCents`, `duration` नहीं `durationSec`। इससे क्लाइंट पर यूनिट-मिसमैच बग की पूरी श्रेणी रुक जाती है।

## बूलियन प्रश्न की तरह पढ़े जाते हैं

बूलियन को इस तरह प्रीफ़िक्स करें कि वे स्वाभाविक रूप से पढ़े जाएँ: `isActive`, `hasShipped`, `canCancel` — न कि `active` या `shipped` जैसी अस्पष्ट संज्ञाएँ जो स्टेटस स्ट्रिंग भी हो सकती हैं।

**Quiz:** टॉप-लेवल API रिस्पॉन्स के नंगे JSON ऐरे `[ {...}, {...} ]` होने का मुख्य जोखिम क्या है?

- [ ] यह ऑब्जेक्ट से पार्स करने में धीमा है
- [x] आप बाद में ब्रेकिंग चेंज किए बिना मेटाडेटा (पेजिनेशन, टोटल) नहीं जोड़ सकते
- [ ] JSON आधिकारिक रूप से टॉप लेवल पर ऐरे सपोर्ट नहीं करता

*Answer:* आप बाद में ब्रेकिंग चेंज किए बिना मेटाडेटा (पेजिनेशन, टोटल) नहीं जोड़ सकते. एक बार क्लाइंट ऐरे की उम्मीद करने लगे, तो हर मौजूदा उपभोक्ता को तोड़े बिना आप उसे `meta` या `total` जैसे फ़ील्ड जोड़ने के लिए ऑब्जेक्ट में नहीं लपेट सकते।