JSON फॉर्मेटिंग सर्वोत्तम प्रथाएँ: पठनीय, वैध और कुशल
त्वरित जवाब
मानव-पठनीय JSON के लिए 2-space indentation, कोई trailing comma नहीं, double-quoted key, संगत key क्रम उपयोग करें। उत्पादन transport के लिए minify, development के लिए pretty-print करें। हमारे मुफ्त JSON Formatter से तुरंत बदलें।
परिचय
JSON फॉर्मेटिंग विकल्प पठनीयता, फ़ाइल आकार और debug गति को प्रभावित करते हैं। यद्यपि JSON syntaxis RFC 8259 द्वारा कठोर निर्दिष्ट है, indentation, key क्रम और whitespace convention का विषय है। यह गाइड व्यापक रूप से अपनाई गई best practice समझाती है ताकि JSON टीमों में संगत, debug में सरल और wire पर कुशल हो।
क्रमशः
-
इंडेंटेशन चौड़ाई चुनें
2 स्पेस सबसे आम परंपरा है (प्रीटियर, ईएसलिंट, गूगल JSON स्टाइल गाइड)। गहराई से नेस्टेड कॉन्फ़िगरेशन के लिए 4 स्थान स्वीकार्य हैं। टैब को हतोत्साहित किया जाता है क्योंकि प्रतिपादन संपादकों के अनुसार अलग-अलग होता है। एक चुनें और इसे पूरे प्रोजेक्ट में लागू करें।
-
लगातार कुंजियाँ ऑर्डर करें
या तो नियतात्मक आउटपुट के लिए कुंजियों को वर्णानुक्रम में क्रमबद्ध करें (कैशिंग और अंतर के लिए उपयोगी) या डोमेन अर्थ के आधार पर समूहित करें (पहले आईडी, फिर विशेषताएँ, फिर संबंध)। यादृच्छिक कुंजी क्रम से बचें - यह अंतर को शोर बनाता है और स्नैपशॉट परीक्षणों को तोड़ देता है।
-
उत्पादन परिवहन के लिए न्यूनतमकरण करें
मिनिफाइड JSON सभी गैर-आवश्यक रिक्त स्थान को हटा देता है, जिससे पेलोड का आकार 10-0% कम हो जाता है। उत्पादन में APIs से न्यूनतम JSON परोसें, और केवल स्थानीय विकास और डिबगिंग के लिए सुंदर-मुद्रित JSON रखें।
-
भेजने से पहले सत्यापित करें
API को भेजने या कॉन्फ़िगरेशन फ़ाइल में लिखने से पहले हमेशा JSON को एक सत्यापनकर्ता के माध्यम से चलाएं। एक एकल अनुगामी अल्पविराम या गैर-उद्धृत कुंजी उपभोक्ता को फेंकने और तोड़ने के लिए JSON.parse() का कारण बनेगी।
-
मोड स्विच करने के लिए फ़ॉर्मेटर का उपयोग करें
पढ़ने के लिए सुंदर बनाने या परिवहन के लिए छोटा करने के लिए अपने JSON को JSON फ़ॉर्मेटर में चिपकाएँ। टूल सिंटैक्स को मान्य करता है और किसी भी त्रुटि के सटीक स्थान की रिपोर्ट करता है, जिससे डिबगिंग समय की बचत होती है।
उदाहरण
सुंदर-मुद्रित (2-स्पेस इंडेंट)
इनपुट: {"id":1,"name":"Alice","active":true}
उत्पादन: {
"id": 1,
"name": "Alice",
"active": true
}
उत्पादन के लिए छोटा किया गया
इनपुट: {
"id": 1,
"name": "Alice"
}
उत्पादन: {"id":1,"name":"Alice"}
वर्णानुक्रम में क्रमबद्ध कुंजियाँ
इनपुट: {"zebra":1,"apple":2,"mango":3}
उत्पादन: {"apple":2,"mango":3,"zebra":1}
सामान्य समस्या
- अनुगामी अल्पविराम: {"a":1,} अमान्य है JSON। अधिकांश फ़ॉर्मेटर उन्हें हटा देते हैं, लेकिन JSON.parse() जैसे सख्त पार्सर इनपुट को अस्वीकार कर देंगे।
- एकल उद्धरण और गैर-उद्धृत कुंजियाँ: {'a':1} और {a:1} वैध जावास्क्रिप्ट हैं लेकिन अमान्य JSON हैं। कुंजियों और स्ट्रिंग मानों के लिए हमेशा दोहरे उद्धरण चिह्नों का उपयोग करें।
- JSON में टिप्पणियाँ: मानक JSON // या /* */ टिप्पणियों की अनुमति नहीं देता है। यदि आपको इनलाइन दस्तावेज़ीकरण की आवश्यकता है तो JSONC, JSON5, या एक अलग स्कीमा फ़ाइल का उपयोग करें।
- मिश्रित इंडेंटेशन: टैब और रिक्त स्थान को मिलाने से अलग-अलग उपकरण टूट जाते हैं और "असंगत इंडेंटेशन" लिंट त्रुटियां हो सकती हैं। प्रतिबद्ध होने से पहले एक फ़ॉर्मेटर के साथ सामान्यीकृत करें।
सुझावों
- अपने संपादक को 2-स्पेस इंडेंटेशन के साथ सहेजने पर JSON प्रारूप में कॉन्फ़िगर करें - यह कोड समीक्षा में शैली संबंधी बहस को रोकता है।
- API प्रतिक्रियाओं के लिए, सामग्री-प्रकार सेट करें: एप्लिकेशन/जेसन; charset=utf-8 और अधिकतम दक्षता के लिए gzip/Brotli संपीड़न के साथ न्यूनतम JSON परोसें।
- जब JSON को हैश किया जाता है या स्नैपशॉट परीक्षणों में तुलना की जाती है तो नियतात्मक कुंजी क्रम (उदाहरण के लिए, वर्णमाला क्रम) का उपयोग करें - यादृच्छिक क्रम गलत-सकारात्मक विफलताओं का कारण बनता है।
- बड़े JSON पेलोड को डिबग करते समय, पहले इसे प्री-प्रिंट करें, फिर आंख से स्कैन करने के बजाय संबंधित सबट्री को निकालने के लिए regex या jq का उपयोग करें।