مستكشف API

مستكشف API هو بيئة تطوير متكاملة داخل المتصفح لاستكشاف واجهة GraphQL API الخاصة بمشروعك. يسمح لمطوري Archie Core ببناء وتنفيذ استعلامات GraphQL بسهولة من داخل مساحة العمل.

يستخدم مستكشف API بياناتك الحية الفعلية.

---

الاستبطان

يحتوي مخطط GraphQL على نظام استبطان مدمج ينشر بنية المخطط. يتيح هذا لمستكشف API توفير ميزات إكمال تلقائي قوية عند كتابة استعلامات GraphQL.

بمجرد الدخول إلى كتلة items، اكتب “em”. من هنا، من السهل رؤية واختيار حقل email من العمليات المتاحة في API. الإكمال التلقائي سياقي حسب موقعك في الاستعلام الذي يتم بناؤه، ويُرشّح الخيارات بناءً على ما يتم كتابته.

لتفعيل قائمة الإكمال التلقائي يدويًا وعرض الخيارات المتاحة، اضغط على مجموعة المفاتيح [Shift] + [SPACE]. يعرض هذا الإجراء قائمة السياق، مما يسمح لك بتحديد الحقل المطلوب، مثل items، من القائمة.

بالإضافة إلى ذلك، يساعدنا الاستبطان في اكتشاف الأخطاء في الاستعلامات. يتعرف النظام عندما لا تكون الأنواع المختلفة متاحة أو تم تكوينها بشكل غير صحيح. لذلك، عند استخدام مستكشف API، مرر فوق الخطوط الحمراء المتعرجة لكشف تلميحات الأخطاء.

الوصول إلى توثيق API

يتضمن مستكشف API مرجعًا مدمجًا للمخطط لمساعدتك على فهم نموذج البيانات الخاص بك أثناء كتابة الاستعلامات.

1. لوحة التوثيق

انقر على زر Documentation الموجود في شريط الأدوات العلوي الأيمن.

2. التنقل السريع السياقي

يمكنك الانتقال مباشرة إلى التوثيق لحقل معين تكتبه.

المُنشئ

المُنشئ هو أداة بناء استعلامات مرئية تكون مفتوحة عادةً بشكل افتراضي على الجانب الأيسر من مستكشف API.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}