مدقّق JSON Schema

ما وظيفته

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

يتحقق هذا المدقّق من مستند JSON مقابل مخطط ويعرض كل مشكلة يجدها. يبيّن كل خطأ موضعه في البيانات (JSON Pointer مثل /tags/1) ورسالة واضحة والكلمة المفتاحية التي فشلت في المخطط، فتصلح البيانات أو المخطط بسرعة. يدعم draft 2020-12 و2019-09 وdraft-07 وdraft-04، بما في ذلك $ref و$defs وallOf/anyOf/oneOf وif/then/else وunevaluatedProperties وفحص الصيغ.

طريقة الاستخدام

1. الصق البيانات في بيانات JSON والمخطط في JSON Schema، أو ارفع ملفًا لكل جانب. يحمّل مثال سجل مستخدم فيه بعض الأخطاء المتعمّدة.
2. تتحدّث النتيجة أثناء الكتابة: شارة خضراء عندما تكون البيانات صالحة، وإلا يظهر عدد الأخطاء وقائمتها.
3. اترك الإصدار على تلقائي ليتبع $schema، أو اختر إصدارًا بعينه. أوقف عرض كل الأخطاء للتوقف عند أول خطأ.
4. ينسخ زر نسخ الأخطاء القائمة نصًا عاديًا، لتقرير خلل أو مراجعة شيفرة.

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

مثال

مع هذا المخطط:

{
  "type": "object",
  "required": ["id"],
  "properties": {
    "id": { "type": "integer" },
    "age": { "type": "integer", "minimum": 0 }
  }
}

ينتج المستند {"age": -1} خطأين: في (الجذر) الخاصية الإلزامية id مفقودة، وفي /age القيمة أقل من الحد الأدنى 0.

نصائح

أضف "additionalProperties": false لاكتشاف أسماء الخصائص المكتوبة خطأً، والتي تمرّ بصمت بخلاف ذلك. استخدم enum أو const للقيم الثابتة وpattern للسلاسل مثل رموز المنتجات. عندما يكبر المخطط، انقل الأجزاء المتكررة إلى $defs وأشر إليها باستخدام $ref.