ما وظيفة منشئ مخطط JSON؟

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

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

  1. ألصق عينة JSON أو اكتبها في مربع الإدخال.
  2. اختر مسودة JSON Schema لسطر $schema: Draft 2020-12 أو Draft 7.
  3. اختر ما إذا كان ينبغي وضع علامة على الخصائص باعتبارها مطلوبة.
  4. انسخ المخطط أو نزّله باسم schema.json.

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

كيفية استنتاج المخطط

  • يُحدَّد نوع JSON لكل قيمة: string وboolean وnull وobject وarray، وinteger للأعداد الصحيحة أو number للأعداد العشرية. تُسند القيمة number إلى المصفوفة التي تضم أعدادًا صحيحة وعشرية، لأنها تشمل النوعين.
  • تحصل الكائنات على إدخال properties لكل مفتاح، مع وصفه بالطريقة نفسها، وصولًا إلى أعمق مستوى في العينة.
  • تحصل المصفوفات على مخطط items واحد يناسب جميع العناصر. وعندما تكون العناصر كائنات، تُدمج خصائصها، لتنتج عن قائمة السجلات مخطط واحد للسجل.
  • تحصل القيم ذات الأنواع المتعددة على جميع أنواعها في قائمة، مثل ["string", "null"]، أو على anyOf عند المزج بين الكائنات والقيم الأخرى.
  • تحصل المصفوفة الفارغة على "type": "array" من دون items، إذ لا يوجد ما يمكن وصفه.

الخصائص المطلوبة

عند تفعيل الخيار «وضع علامة على الخصائص باعتبارها مطلوبة»، يُدرج كل كائن مفاتيحه ضمن required. أما في مصفوفة من الكائنات، فلا تُعد الخاصية مطلوبة إلا إذا وُجدت في كل عنصر: ففي قائمة أعضاء لا يملك فيها بعضهم سوى خاصية favorite، تكون هذه الخاصية اختيارية. أوقف الخيار للحصول على مخطط بلا قوائم required.

ما لا يمكن استنتاجه من عينة

لا يعرف المخطط المُنشأ من مثال واحد سوى ما تعرضه العينة. فلا يمكنه معرفة أي قيم نصية تمثل عناوين بريد إلكتروني أو تواريخ، أو النطاقات التي قد تأخذها الأعداد، أو أن خاصية ظهرت مرة واحدة قد تكون غائبة أيضًا. أضف format أو minimum أو maxLength أو enum أو pattern يدويًا عند الحاجة، ثم تحقّق من صحة البيانات باستخدام مدقق مخطط JSON.

آلية العمل

تستخدم الأداة genson-js، وهي نسخة من منشئ المخططات GenSON مطوّرة بلغة JavaScript. تؤدي الكلمات المفتاحية التي تُنشئها المعنى نفسه في Draft 7 وDraft 2020-12، لذا لا تؤثر المسودة إلا في سطر $schema. يجري كل شيء في متصفحك، ولا تُحمَّل العينة مطلقًا.

الميزات

  • إنشاء مخطط JSON من أي عينة JSON
  • استنتاج الأنواع والكائنات المتداخلة والمصفوفات تلقائيًا
  • دمج عناصر المصفوفة في مخطط واحد، مع اكتشاف الخصائص الاختيارية
  • Draft 2020-12 أو Draft 7
  • تفعيل الخصائص المطلوبة أو إيقافها
  • النسخ أو التنزيل باسم schema.json
  • تعمل في متصفحك