مشاركة عبر

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

  • مقالة

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

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

إشعار

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

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

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

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

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

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

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

    تحديد خدمات إدارة واجهة برمجة التطبيقات

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

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

أضف مخطط 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 لتحديد واجهة برمجة التطبيقات المحددة هذه في مثيل APIM. يجب أن يكون فريداً في مثيل APIM.
    عنوان URL الأساسي حقل غير قابل للتعديل يعرض عنوان URL الأساسي الخاص بواجهة برمجة التطبيقات
    العلامات اربط واجهة برمجة تطبيقات GraphQL بعلامات جديدة أو حالية.
    المنتجات اربط واجهة برمجة تطبيقات GraphQL الخاصة بك بمنتج لنشره.
    إصدار واجهة برمجة التطبيقات هذه؟ قم بتحديد ذلك لتطبيق مخطط تعيين الإصدار على واجهة برمجة تطبيقات GraphQL الخاصة بك.

  4. حدد إنشاء.

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

تكوين محلل

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

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

type Query {
    users: [User]
}

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

  1. من قائمة التنقل الجانبية، ضمن قسم APIs، حدد APIs> لواجهة برمجة تطبيقات GraphQL.

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

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

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

      لقطة شاشة لإضافة محلل GraphQL في المدخل.

  3. في صفحة إنشاء محلل :

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

  4. في محرر نهج الحل، قم بتحديث العنصر مع العناصر التابعة <http-data-source> للسيناريو الخاص بك. على سبيل المثال، يسترد محلل التالي حقل المستخدمين عن طريق إجراء استدعاء 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>

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

  5. حدد إنشاء.

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

تلميح

أثناء تحرير نهج محلل، حدد 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.

الخطوات التالية

تحويل واجهة برمجة تطبيقات منشورة وحمايتها