عارض JSON

ما هو JSON ولماذا قد ترغب في عرضه بشكل مختلف

JSON (JavaScript Object Notation) هو التنسيق النصي الأكثر شيوعًا لتبادل البيانات المنظمة على الويب: ملفات الإعدادات، واستجابات واجهات API، وسجلات السجل، ومخازن المستندات، وغيرها الكثير. إنه صغير وقابل للقراءة من قبل البشر ويمكن تحليله آليًا بسهولة، ولهذا السبب تتحدث به كل خدمة حديثة تقريبًا.

مستند JSON الخام نادرًا ما يكون مفيدًا بحد ذاته. غالبًا ما تصدر واجهات API والأدوات سطرًا واحدًا طويلًا بدون مسافات بيضاء، لأن ذلك هو أقصر تمثيل. عندما تفتح مثل هذا المستند في محرر فإنه يصعب فحصه، ويصعب اكتشاف الأقواس غير المتطابقة، ومن السهل أن تفقد مكانك أثناء عد الأقواس المعقوفة. يحل عارض JSON هذه المشكلة بإعادة إصدار المستند بمسافة بادئة متسقة بحيث يصبح الهيكل واضحًا في لمحة.

ميزات تستحق المعرفة

تتيح لك الطباعة الجميلة اختيار حجم المسافة البادئة (عادةً مسافتان أو أربع مسافات) وتعرض المستند على الفور. تتيح لك بعض العارضات أيضًا فرز المفاتيح أبجديًا، وهو أمر لا يقدر بثمن عند مقارنة حمولتين من نفس الخدمة: عندما تصطف المفاتيح عموديًا يمكنك فحص اختلافات القيم دون مطابقتها بالموقع. خط الإحصائيات الذي يعرض عدد البايتات وعدد العقد مفيد عندما تكون على وشك لصق حمولة في نموذج محدود بـ 1 ميغابايت: فهو يخبرك بالحجم الدقيق دون فتح طرفية.

العارض هو أيضًا مدقق. عملية التحليل باستخدام JSON.parse ستلقي خطأ وصفيًا يشير إلى السطر والعمود الدقيقين لأول رمز غير صالح، بحيث يمكنك رؤية سبب رفض مستندك للتحميل على الفور. تنتج معظم أدوات الإنتاج أخطاء في نفس النقطة، لذا فإن الرسالة التي تراها هنا تطابق ما سيقوله خادمك أو إطار عمل الواجهة أو خط أنابيب البناء.

نصائح سير العمل

استخدم أدوات الطي/التوسيع للتركيز على المستوى الأعلى لمستند متداخل بعمق، ثم تعمق في القسم الذي يهمك، وانسخ الفرع الذي تحتاجه. إذا كنت تتصيد الأخطاء في استجابة واجهة API، قم بفرز المفاتيح قبل المقارنة بحيث لا تربك عينيك الإضافات والحذف في مواقع مختلفة. عند الشك، الصق المستند في تبويب جديد، واضبط التنسيق، واستخدم الإخراج كنسخة معيارية للتوثيق أو رسائل الإيداع.