مولّد JSON Schema (مسودة 2020-12)

ما هو مولّد JSON Schema؟

استنتج JSON Schema من مستند مثال. يصف المولّد نوع كل خاصية، ويدمج عناصر المصفوفات في مخطط items واحد، ويسرد المفاتيح الإلزامية، ويعلّم القيم القابلة لـ null باتحادات الأنواع، ويمكنه اكتشاف صيغ النصوص الشائعة.

كيفية استخدام مولّد JSON Schema

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

مثال

{"id":1,"email":"a@b.co"}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "email": {
      "type": "string",
      "format": "email"
    }
  },
  "required": [
    "id",
    "email"
  ]
}

متى تستخدم مولّد JSON Schema

استخدمه كنقطة انطلاق لعقود API والتحقق من الإعدادات وتوليد النماذج. المخطط المستنتج من عيّنة واحدة بجودة العيّنة نفسها: أضف قيودًا مثل minimum أو enum أو pattern يدويًا قبل استخدامه للتحقق من بيانات حقيقية.

كيف يعمل مولّد JSON Schema

تُجتاز العيّنة تكراريًا ويجمع كل موضع أنواع JSON التي رآها (integer وnumber وstring وboolean وobject وarray وnull). تصبح الأعداد الصحيحة المختلطة بكسرية number؛ وتصبح الأنواع المتعددة مصفوفة type مثل ["object", "null"]. وفي مصفوفات الكائنات تكون الخاصية إلزامية فقط إذا وُجدت في كل كائن. ويفحص اكتشاف الصيغ النصوص مقابل أنماط date-time وdate وtime وemail وuuid وuri وipv4 ولا يضيف format إلا إذا طابقت كل القيم. وتصرّح النتيجة بـ $schema: https://json-schema.org/draft/2020-12/schema.

حالات الاستخدام الشائعة

• ✓ إنشاء مخطط أولي لجسم طلب API
• ✓ التحقق من ملفات الإعداد بـ ajv أو فحص في CI
• ✓ توثيق شكل حمولة webhook
• ✓ توليد نماذج من مخطط في أدوات تقبل JSON Schema

الأسئلة الشائعة

الخطوات التالية المقترحة

استكشف المزيد من الفئات