مولد تعريفات نوع GraphQL من JSON

مولد تعريفات نوع GraphQL من JSON

أدخل أي كائن أو مصفوفة JSON واحصل فورًا على مستند مُعرّف للنظام (SDL) يصف شكله. يقوم المُولد بتنقل شجرة JSON، وينتج أنواعًا مُتسلسلة، وينسق الأسماء المُتسلسلة للأجسام المُتداخلة، ويُصدر نوع جذري اختياري Query لأن الناتج جاهز للإدخال في خادم مثل Apollo، Yoga، Mercurius، أو graphql-go.

لماذا يهم مُحول مُحدد من JSON إلى SDL للغة GraphQL؟

كتابة أنواع GraphQL يدويًا من نموذج بيانات يُعدّ ميكانيكيًا لكنه معرض للخطأ. خطأ في تجاهل الإسقاط، أو عدم التوازن Int — أي منهما تحتاجه؟ Float، أو نسي تعيين علامة غير مسموح لها على عنصر قائمة يمكن أن يُوقف إنشاء الكود لجميع العملاء المُستقبلين. يُعامل المُولد المُحكم نفس النموذج JSON بشكل متماثل كل مرة، مما يجعله آمنًا لإعادة التوليد مع أي تغيير في واجهة الخدمة.

كيفية استخدام

1. أدخل كائنًا أو مصفوفة JSON في مربع الإدخال، أو اضغط على اختر مثالًا لتحميل نموذج بيانات مُمثل.
2. اضبط اسم نوع الجذر إذا كنت ترغب في شيء مختلف عن Root.
3. اختر قابلية الحقل للإسقاط استراتيجية – صارمة (!) لحقول مطلوبة أو جميع الإسقاطات للإختبارات الأولية.
4. تبديل تَعَرُّف مُعرف (ID) لتحويل id و *Id المفاتيح إلى نوع ID المُتسلسل.
5. بمُضافة اختياريًا نوع جذري Query بمجالات كائن فردي وقائمة.
6. انسخ SDL أو احفظه كـ schema.graphql.

خصائص

• تَعَرُّف أنواع مُتسلسلة – يُميز String, Int, Float, Booleanو، و ID بشكل مُحدد.
• أنواع الكائنات المُتداخلة – يُنتج نوعًا مُسمى منفصل لكل كائن مُتداخل باستخدام صيغة باسل كايس من مفتاح الحقل.
• دمج مصفوفات الكائنات – يُدمج كل حقل عبر عناصر المصفوفة بحيث تُعرف الحقول المُتاحة بشكل صحيح.
• مُضافة أو إلغاء الإسقاط بين الحقول – يُصدر علامات صارمة ! أو يُخفف كل شيء إلى إسقاطات للإختبارات المبكرة.
• تَعَرُّف تلقائيًا للمعرف (ID) – يُرفع مفاتيح النمط id, userId, orderId إلى ID المُتسلسل.
• مُخطط الاستعلام الجذري – اختياري type Query { ... } بأوامر مُتسلسلة للكائنات الفردية والقائمة.
• العملية فقط من جانب العميل – لا يُخرج JSON من المتصفح، لذا فإن الأداة آمنة للبيانات الحساسة.

قواعد تَعَرُّف أنواع

• الإحصائيات المُتسلسلة تُحول إلى Int؛ الأعداد التي تحتوي على جزء كسري تُحول إلى Float. إذا تم رؤية الحقل كمُتسلسل يُرفع إلى Float.
• السلاسل تُحول إلى String. مع تفعيل تَعَرُّف المعرف، تُصبح المفاتيح المُسمّاة id أو التي تنتهي بـ Id مُعرفًا ID.
• القيم الثنائية تُحول إلى Boolean.
• null تُحدد القيم المُسموح بها للحقل، لذا يُستبعد التحقق من القيم المُتسلسلة في الناتج المُولد !.
• المصفوفات الفارغة تُستخدم كـ [String] لأن لا يمكن تعيين نوع عنصر آمن.
• تُدمج مصفوفات الكائنات إلى نوع مُسمى واحد؛ تُصبح الحقول المفقودة من أي عنصر مُسموحًا بها تلقائيًا.

من يستخدم هذا؟

• مُهندسون في الخلفية الذين يُحيطون بواجهة REST أو ملف JSON ببوابة GraphQL.
• مُطوّرون في الواجهة الأمامية الذين يُختبرون نموذجًا لشكل المُدخلات قبل أن تكون الواجهة جاهزة.
• مُصممون واجهات يُوثقون أشكال الاستجابة من مُزوّد خارجي كعقدة مُتسلسلة.
• مُسارات إنشاء الكود التي تحتاج إلى نسخة مُتكررة من مُعرّف النموذج (SDL) من نموذج JSON مستقر.