كيف تختبر واجهة GraphQL API في VS Code

بقلم Sayaib Sarkarآخر تحديث قراءة في 2 دقيقة

في هذه الصفحة 6 قسم

الإجابة المختصرة: طلب GraphQL هو طلب HTTP ‏POST بجسم JSON يحمل الاستعلام ومتغيراته، واسم العملية اختياريًا. ويمكن لأي عميل REST يفهم GraphQL إرساله. يستخدم هذا الدليل REST API Client المجاني في DevSnip Pro، الذي يتضمن وضع GraphQL بحقول منفصلة للاستعلام والمتغيرات واسم العملية.

1. بدّل العميل إلى GraphQL

  1. شغّل DevSnip Pro: REST API Client من لوحة الأوامر (Ctrl/Cmd+Shift+P).
  2. بدّل البروتوكول من HTTP إلى GraphQL (بجوار اسم الطلب). تُستبدل علامة التبويب Body بعلامة Query.
  3. اضبط الطريقة على POST وأدخل نقطة النهاية، مثل https://countries.trevorblades.com/ (واجهة عرض عامة) أو {{baseUrl}}/graphql.

إذا كانت الطريقة GET، ينبّه العميل إلى أن الاستعلام لن يُرسل ويقترح Use POST.

2. اكتب الاستعلام والمتغيرات

في حقل Query:

GraphQL
query GetCountry($code: ID!) {
  country(code: $code) {
    name
    capital
    currency
  }
}

وفي Variables (JSON):

JSON
{ "code": "DE" }

يُفحص حقل المتغيرات أثناء الكتابة، فيُنبَّه إلى JSON غير الصالح قبل الإرسال. واملأ Operation name ‏(GetCountry) حين يحتوي المستند على أكثر من عملية.

3. أرسل واقرأ الاستجابة

اضغط Ctrl/Cmd+Enter أو Send. تجيب خوادم GraphQL عادةً بـ 200 OK حتى عند فشل الاستعلام، لذا اقرأ الجسم:

  • يحمل data النتيجة؛
  • ويعرض errors المشكلات مع رسالة ومسار. وقد تحتوي الاستجابة على كليهما، ما يعني نتيجة جزئية.

4. أضف المصادقة والبيئات

تستخدم واجهات GraphQL المصادقة نفسها التي تستخدمها واجهات REST. ضع الرمز في متغير بيئة واضبط مصادقة Bearer على {{token}}؛ وبدّل البيئات لتشغيل الاستعلام نفسه على البيئة المحلية وبيئة الاختبار. واحفظ الطلب في مجموعة ليصبح الاستعلام وثيقة مرجعية.

5. نسّق الاستعلامات وولّد الأنواع

افتح GraphQL Formatter & Types من قسم Backend & API في الشريط الجانبي Tools:

  • ينسّق Query: format & request الاستعلام أو يضغطه، ويعرض عملياته ومتغيراته، ويبني جسم طلب JSON وأمر cURL واستدعاء fetch. وينبّه إلى الأجزاء (fragments) غير المعرّفة أو غير المستخدمة والعمليات غير المسماة.
  • يحوّل Schema (SDL) → TypeScript المخطط إلى أنواع TypeScript. ولعمليات بأنواع كاملة، يذهب GraphQL Code Generator أبعد.

حدود يجدر معرفتها

  • لا يوجد مستكشف للمخطط ولا إكمال تلقائي من الاستبطان (introspection)؛ اكتب الاستعلام بنفسك أو الصقه من قاعدة شيفرتك.
  • ليس لاشتراكات GraphQL عبر WebSocket وضع مخصص. وأداة WebSocket في العميل ميزة متقدمة تُدفع بالنقاط.

جرّبه في محررك

مجاني، دون حساب، ويعمل محليًا. لـ VS Code 1.93 أو أحدث وبيئات JetBrains على Windows أو macOS أو Linux.

code --install-extension sayaib.hue-console