مشاركة عبر

إضافة واجهة برمجة تطبيقات GraphQL اصطناعية وإعداد محللات الحقول

ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات

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

إشعار

حاليا، هذه الميزة غير متوفرة في مساحات العمل.

في هذه المقالة، سوف تتمكن من:

  • استيراد مخطط GraphQL إلى مثيل إدارة واجهة برمجة تطبيقات Azure.
  • قم بإعداد محلل لاستعلام GraphQL باستخدام نقطة نهاية HTTP موجودة.
  • اختبر واجهة برمجة تطبيقات GraphQL الخاصة بك.

إذا كنت تريد عرض نقطة نهاية GraphQL موجودة كواجهة برمجة تطبيقات، فراجع استيراد واجهة برمجة تطبيقات GraphQL.

المتطلبات الأساسية

الانتقال إلى مثيل إدارة واجهة برمجة التطبيقات لديك

  1. في مدخل Microsoft Azure، ابحث عن خدمات APIM وحددها:

    لقطة شاشة تعرض خدمات APIM في نتائج البحث.

  2. في صفحة خدمات إدارة واجهة برمجة التطبيقات ، حدد مثيل إدارة واجهة برمجة التطبيقات:

    لقطة شاشة تعرض مثيل APIM في صفحة خدمات APIM.

أضف مخطط GraphQL

  1. في الجزء الأيمن، ضمن واجهات برمجة التطبيقات، حدد واجهات برمجة التطبيقات.

  2. ضمن تحديد واجهة برمجة تطبيقات جديدة، حدد لوحة GraphQL .

    لقطة شاشة لتحديد لوحة GraphQL.

  3. في مربع الحوار، حدد كامل، ثم أدخل قيما في الحقول المطلوبة، كما هو موضح في الجدول التالي.

    لقطة شاشة لصفحة الإنشاء من مخطط GraphQL.

    قيمة الوصف
    ‏‫اسم العرض‬ الاسم الذي ستُعرض به واجهة برمجة تطبيقات GraphQL.
    الاسم الاسم الخام لواجهة برمجة تطبيقات GraphQL. يتم ملؤه تلقائيًا أثناء كتابة الاسم المعروض.
    نوع GraphQL حدد GraphQL الاصطناعية للاستيراد من ملف مخطط GraphQL.
    نقطة نهاية GraphQL الاحتياطية أدخل عنوان URL اختياريا باسم نقطة نهاية GraphQL API. إدارة واجهة برمجة التطبيقات APIM تمرر استعلامات GraphQL إلى نقطة النهاية هذه عندما لا يتم تعيين محلل مخصص لحقل.
    الوصف أضف وصفًا لواجهة برمجة التطبيقات الخاصة بك.
    مخطط URL حدد نظاما استنادا إلى نقطة نهاية GraphQL. حدد أحد الخيارات التي تتضمن نظام WebSocket (WS أو WSS) إذا كانت واجهة برمجة تطبيقات GraphQL تتضمن نوع الاشتراك. التحديد الافتراضي هو HTTP(S).
    لاحقة عنوان URL لواجهة برمجة التطبيقات أضف لاحقة عنوان URL لتحديد واجهة برمجة التطبيقات المحددة في مثيل إدارة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل إدارة واجهة برمجة التطبيقات.
    عنوان URL الأساسي حقل غير قابل للتحرير يعرض عنوان URL الأساسي لواجهة برمجة التطبيقات.
    العلامات اختياريا، قم بربط واجهة برمجة تطبيقات GraphQL الخاصة بك بعلامات جديدة أو حالية.
    المنتجات اربط واجهة برمجة تطبيقات GraphQL الخاصة بك بمنتج لنشره.
    إصدار واجهة برمجة التطبيقات هذه؟ حدد خانة الاختيار لتطبيق مخطط تعيين الإصدار على واجهة برمجة تطبيقات GraphQL.

  4. حدد إنشاء.

  5. بعد إنشاء واجهة برمجة التطبيقات، راجع المخطط أو عدله في علامة التبويب المخطط .

تكوين محلل

تكوين محلل لتعيين حقل في المخطط إلى نقطة نهاية HTTP موجودة. يتم توفير خطوات عالية المستوى هنا. للحصول على التفاصيل، راجع تكوين محلل GraphQL.

لنفترض أنك قمت باستيراد مخطط GraphQL الأساسي التالي وتريد إعداد محلل للاستعلام users .

type Query {
    users: [User]
}

type User {
    id: String!
    name: String!
}

  1. في الجزء الأيمن، ضمن واجهات برمجة التطبيقات، حدد واجهات برمجة التطبيقات.

  2. حدد واجهة برمجة تطبيقات GraphQL الخاصة بك.

  3. في علامة التبويب المخطط ، راجع المخطط لحقل في نوع كائن تريد تكوين محلل فيه.

    1. حدد حقلا، ثم مرر مؤشر الماوس في الهامش الأيسر.

    2. حدد إضافة محلل.

      لقطة شاشة لإضافة محلل GraphQL في البوابة.

  4. في جزء إنشاء محلل :

    1. قم بتحديث خاصية الاسم إذا كنت تريد ذلك، وأدخل وصفا اختياريا، وتأكد من تحديدات النوع وحقلأو حدثهما.
    2. في مصدر البيانات، حدد HTTP API.

  5. في محرر نهج الحل، قم بتحديث العنصر مع العناصر التابعة <http-data-source> للسيناريو الخاص بك. على سبيل المثال، يقوم users المحلل التالي باسترداد الحقل عن طريق إجراء مكالمة GET إلى مصدر بيانات HTTP موجود.

        <http-data-source>
        <http-request>
            <set-method>GET</set-method>
            <set-url>https://myapi.contoso.com/users</set-url>
        </http-request>
    </http-data-source>

    لقطة شاشة لتكوين محلل نهج في المدخل.

  6. حدد إنشاء.

  7. لحل البيانات لحقل آخر في المخطط، كرر الخطوات السابقة لإنشاء محلل آخر.

تلميح

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

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

  1. انتقل إلى مثيل APIM الخاص بك.

  2. في الجزء الأيمن، في قسم واجهات برمجة التطبيقات ، حدد واجهات برمجة التطبيقات.

  3. ضمن جميع واجهات برمجة التطبيقات، حدد واجهة برمجة تطبيقات GraphQL الخاصة بك.

  4. حدد علامة تبويب اختبار للوصول إلى وحدة الاختبار.

  5. ضمن الرؤوس:

    1. حدد الرأس من قائمة الاسم .
    2. أدخل القيمة في مربع القيمة .
    3. أضف المزيد من الرؤوس عن طريق تحديد إضافة رأس.
    4. حذف الرؤوس باستخدام زر سلة المحذوفات.

  6. إذا أضفت منتجا إلى واجهة برمجة تطبيقات GraphQL، أضف نطاق منتج ضمن تطبيق نطاق المنتج.

  7. في محرر الاستعلام، قم بأحد الإجراءات التالية:

    1. حدد حقلا أو حقلا فرعيا واحدا على الأقل من القائمة الموجودة في القائمة الموجودة على يمين المحرر. تظهر الحقول والحقول الفرعية التي تحددها في محرر الاستعلام.

    2. ابدأ الكتابة في محرر الاستعلام لإنشاء استعلام.

      لقطة شاشة لمحرر الاستعلام.

  8. ضمن متغيرات الاستعلام، أضف متغيرات لإعادة استخدام نفس الاستعلام أو الطفرة وتمرير قيم مختلفة.

  9. حدد إرسال.

  10. عرض الرد.

    لقطة شاشة لاستجابة استعلام الاختبار.

  11. كرر الخطوات السابقة لاختبار الحمولات الصافية المختلفة.

  12. عند الانتهاء من الاختبار، اخرج من وحدة تحكم الاختبار.

تأمين واجهة برمجة تطبيقات GraphQL

قم بتأمين واجهة برمجة تطبيقات GraphQL الخاصة بك عن طريق تطبيق كل من نهج المصادقة والتخويل الحالية ونهجالتحقق من صحة GraphQL للحماية من الهجمات الخاصة ب GraphQL.

المحتوى ذو الصلة

  • Last updated on