كيف تختبر واجهة برمجة التطبيقات GraphQL في Postman

ما هو GraphQL

GraphQL هي لغة استعلام لـ APIs تم تطويرها بواسطة Facebook في عام 2012. إنها أكثر كفاءة وقوة ومرونة من APIs RESTful، مما يسمح للعملاء بطلب فقط البيانات التي يحتاجونها، مما يقلل من حركة المرور على الشبكة، ويحسن الأداء.

نظام النوع الخاص بها هو ميزة رئيسية، حيث يحدد مخططاً يصف البيانات المتاحة في API وكيف يمكن الوصول إليها، مما يسهل على العملاء كتابة استعلامات صحيحة وفعالة. يمكن أن يتعامل GraphQL مع طلبات متعددة في استعلام واحد، مما يقلل من عدد الرحلات اللازمة للحصول على جميع البيانات المطلوبة.

بشكل عام، يعد GraphQL أداة قوية لبناء APIs التي تحسن الأداء، وتقلل من حركة المرور على الشبكة، وتوفر تجربة مطور أفضل. لقد زادت شعبيته بسرعة في السنوات الأخيرة، حيث اعتمدته العديد من الشركات كتكنولوجيا API المفضلة لديهم.

في القسم التالي، سوف نستكشف كيف يدعم Postman GraphQL وكيفية إنشاء طلبات GraphQL في Postman.

GraphQL في Postman

Postman أداة شائعة لتطوير APIs تدعم مجموعة واسعة من APIs، بما في ذلك GraphQL. يجعل دعم Postman لـ GraphQL من السهل على المطورين اختبار وتصحيح APIs الخاصة بـ GraphQL.

يتضمن دعم Postman لـ GraphQL عارض مخطط GraphQL مدمج يتيح للمطورين عرض مخطط API لـ GraphQL. يوفر عارض المخطط تمثيلًا بصريًا لأنواع API، والحقول، والعلاقات، مما يجعل من السهل فهم هيكل API.

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

يدعم Postman أيضًا متغيرات GraphQL، مما يسمح للمطورين بتمرير معلمات لاستعلاماتهم وتعديلاتهم في GraphQL. يمكن تعريف المتغيرات في جسم الطلب أو في ملف JSON منفصل، مما يجعل من السهل إعادة استخدامها عبر طلبات متعددة.

ميزة أخرى مفيدة لدعم Postman لـ GraphQL هي القدرة على عرض وتعديل بيانات الاستجابة بتنسيق رسومي. يوفر عارض الاستجابة عرضًا شجريًا لبيانات الاستجابة، مما يسهل التنقل وفهم هياكل JSON المعقدة.

بشكل عام، يجعل دعم Postman لـ GraphQL من السهل على المطورين اختبار وتصحيح APIs الخاصة بـ GraphQL. مع عارض المخطط المدمج، ومولد الطلبات، وعارض الاستجابة، يوفر Postman أدوات شاملة للعمل مع APIs الخاصة بـ GraphQL.

كيفية اختبار API GraphQL في Postman

إليك دليل حول كيفية اختبار APIs GraphQL في Postman:

1. افتح Postman وأنشئ طلبًا جديدًا بالنقر على زر "جديد" في الزاوية اليسرى العليا من التطبيق.

2. اختر طريقة "POST"، وأدخل عنوان URL لنقطة نهاية GraphQL الخاصة بك في حقل "URL".

3. اختر علامة التبويب "الجسم" في صفحة الطلب واختر نوع الجسم "GraphQL".

4. اكتب استعلام GraphQL الخاص بك، ثم انقر على زر "إرسال" لتنفيذه وعرض الاستجابة.

يمكنك استخدام المحرر المقدم من Postman لكتابة استعلامك أو تعديلك. يدعم المحرر تمييز الصياغة، والإكمال التلقائي، وإبراز الأخطاء.

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

طريقة اختيارية: يمكنك النقر على "جديد" واختيار "GraphQL" لاختبار API الخاص بك مباشرة.

إذا كانت استعلامك أو تعديلك يرجع كمية كبيرة من البيانات، يمكنك استخدام الترجيع للحد من كمية البيانات المستردة. للقيام بذلك، استخدم الحجج first وafter لتحديد عدد العناصر التي سيتم إرجاعها ومؤشر البداية.

لاستكشاف مخطط GraphQL الخاص بك وبناء استعلامات أكثر تعقيدًا، يمكنك استخدام استكشاف GraphQL. للقيام بذلك، أرسل استعلامًا إلى حقل __schema لنقطة نهاية GraphQL الخاصة بك. سيعيد ذلك معلومات حول مخططك، بما في ذلك الأنواع والحقول والحجج والتوجيهات.

الصياغة الأساسية للغة استعلام GraphQL

GraphQL هي لغة استعلام لـ APIs تم تطويرها بواسطة Facebook. تتيح للعملاء تحديد هيكل البيانات التي يحتاجونها وسيستجيب الخادم بالضبط بتلك البيانات. في هذا القسم، سنستكشف الصياغة الأساسية لاستعلامات GraphQL.

يبدأ استعلام GraphQL عادةً بالكلمة الرئيسية query يليها مجموعة من الأقواس المعقوفة التي تحتوي على الحقول التي يرغب العميل في استردادها. على سبيل المثال، قد يبدو استعلام بسيط لاسترداد اسم وبريد إلكتروني لمستخدم كالتالي:

query {
  user {
    name
    email
  }
}

في هذا الاستعلام، user هو حقل يمثل نوع كائن. الحقول name و email هي خصائص لذلك النوع من الكائن. لاحظ أنه لا توجد فواصل تفصل بين الحقول داخل نوع الكائن.

يدعم GraphQL أيضًا الحجج، التي تستخدم لتصفية أو ترتيب البيانات. يتم تضمين الحجج بين قوسين ويمكن تمريرها إلى أي حقل يقبلها. على سبيل المثال، لاسترداد الاسم والبريد الإلكتروني لمستخدم برقم تعريف معين، قد يبدو الاستعلام كالتالي:

query {
  user(id: "123") {
    name
    email
  }
}

في هذا الاستعلام، id هو حجة تمرر إلى حقل user. لن يُرجع الخادم البيانات إلا للمستخدم الذي يحمل رقم التعريف "123".

يدعم GraphQL أيضًا الأسماء المستعارة، التي تستخدم لإعادة تسمية الحقول التي تُرجعها استعلام. الأسماء المستعارة مفيدة عندما يكون لدى حقليْن نفس الاسم لكن يمثلان بيانات مختلفة. على سبيل المثال، لاسترداد كل من عنوان الفواتير وعنوان الشحن لمستخدم، قد يبدو الاستعلام كالتالي:

query {
  user(id: "123") {
    billingAddress: address(type: "billing") {
      street
      city
      state
      zip
    }
    shippingAddress: address(type: "shipping") {
      street
      city
      state
      zip
    }
  }
}

في هذا الاستعلام، billingAddress و shippingAddress هما أسماء مستعارة لحقل address. تُستخدم حجة type لتصفية البيانات التي يتم إرجاعها بواسطة حقل address.

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

Apidog: دعم GraphQL

Apidog هي أداة تدعم GraphQL، مما يسمح لك باختبار وتصحيح APIs الخاصة بـ GraphQL لضمان عملها كما هو متوقع. مشابهة لميزة GraphQL في Postman، تتيح لك Apidog إدارة واختبار APIs الخاصة بك بسهولة. نحن نعمل باستمرار على تحسين Apidog مع المزيد من ميزات الأتمتة لجعل اختبار وإدارة APIs الخاصة بك أسهل بكثير. شكرًا لاختيارك Apidog لاحتياجاتك في GraphQL!