النقاط الرئيسية
- 01ينسق الاستعلامات والطفرات والاشتراكات وتعريفات SDL باستخدام محلل graphql.js الرسمي.
- 02يتحقق من الصيغة ويبلغ عن الخطأ برقم السطر والعمود الدقيق — لا يلزم المخطط.
- 03يتم فصل تعليقات GraphQL (#) على التنسيق؛ استخدم سلاسل الوصف للتوثيق التي تريد الحفاظ عليها.
- 04يعمل بالكامل في متصفحك — استعلامات API الداخلية والمخططات الملكية تبقى خاصة.
لماذا نسق مستندات GraphQL؟
يمكن أن تصبح استعلامات GraphQL معقدة بسرعة — أجزاء متداخلة ومتغيرات مضمنة وتعريفات عمليات متعددة وتعريفات نوع SDL مع واجهات وتوجيهات. يجعل التنسيق المتسق مراجعة الأقران أسرع ويسهل اكتشاف الأقواس المفقودة أو عدم تطابق الحجج في لمحة.
يستخدم المنسق محلل graphql.js المرجعي — نفس المحلل الذي تشحنه مواصفات GraphQL معه. هذا يعني أن التنسيق الكنسي الذي تحصل عليه هنا يطابق ما ينتجه مكون Prettier لـ GraphQL وأدوات GraphQL الأكثر شيوعاً. أي شيء يتحلل بنظافة هنا سيتحلل بنظافة في Apollo و Relay و graphql-request.
كيفية تنسيق مستند GraphQL
- 01
الصق GraphQL الخاص بك
الصق استعلام أو طفرة أو اشتراك أو جزء أو تعريف مخطط SDL في لوحة الإدخال.
- 02
انقر فوق التنسيق
يعطي المحلل المستند مسافة بادئة كنسق — مسافة بادئة من نوعين، حقل واحد لكل سطر، محاذاة حجة متسقة. تظهر النتيجة في لوحة الإخراج.
- 03
تحقق اختياراً
انقر فوق التحقق لتأكيد التحلل من مستند دون إنتاج إخراج منسق. النتيجة تأكيد أو قائمة بأخطاء الصيغة برقم السطر والعمود.
- 04
انسخ النتيجة
انقر فوق نسخ لالتقاط المستند المنسق. الصقه في قاعدة الكود أو وصف PR أو ملف توثيق.
آمن للمخططات الداخلية واستعلامات API
يعمل محلل graphql.js بالكامل في متصفحك. لا يتم إرسال نص عملية أو تعريف مخطط إلى أي خادم. هذا يجعلها آمنة لتنسيق الاستعلامات التي تشير إلى أسماء حقل خاصة أو أنظمة نوع داخلية لا تريد كشفها لأدوات تابعة لجهات خارجية.
التحقق هنا من الناحية النحوية فقط — الأداة تفحص أن المستند هو مستند GraphQL صحيح، لكنها لا تفحص ما إذا كانت أسماء الحقول موجودة في مخطط حقيقي أو ما إذا كانت المتغيرات تطابق أنواع الحجج أو ما إذا تم تطبيق التوجيهات بشكل صحيح. يتطلب التحقق الواعي بالمخطط تحميل المخطط المستهدف جنباً إلى جنب مع المستند.
الأسئلة الشائعة حول منسق GraphQL
هل يتحقق تنسيق GraphQL من مخطط؟
لا — فقط التحقق من صيغة. التحقق من وجود الحقول والحجج يتطلب المخطط المستهدف. تؤكد هذه الأداة أن المستند هو مستند GraphQL صحيح، لا أكثر.
هل سيتم الحفاظ على التعليقات في GraphQL الخاص بي؟
لا. يتم فصل الأسطر التي تبدأ بـ #. استخدم سلاسل الوصف المعلقة بثلاث علامات اقتباس للتوثيق الذي يجب أن يبقى على قيد الحياة في التنسيق.
أي إصدار مواصفات GraphQL مدعوم؟
مواصفات أكتوبر 2021، بما فيها كائنات إدخال OneOf وتوجيه @specifiedBy.
هل يمكنني تنسيق تعريفات مخطط SDL وليس فقط وثائق العملية؟
نعم. تعريفات النوع وإعلانات الواجهة وأنواع الاتحاد والتعدادات والتوجيهات والأوصاف جميع الجولة بشكل صحيح من خلال المنسق.
هل يتم تحميل الاستعلام أو المخطط في أي مكان؟
لا. يعمل محلل graphql.js بالكامل في متصفحك — لا شيء يترك جهازك.