استيراد GraphQL API

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

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

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

إذا كنت تريد استيراد مخطط GraphQL وإعداد أدوات حل الحقول باستخدام نقاط نهاية REST أو SOAP API، فراجع استيراد مخطط GraphQL وإعداد أدوات حل الحقول.

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

• مثيل APIM موجود. أنشئ واحد إذا لم تكن قد قمت بذلك بالفعل.

• واجهة برمجة تطبيقات GraphQL.

• Azure CLI

  • استخدم بيئة Bash في Azure Cloud Shell. لمزيد من المعلومات، راجع التشغيل السريع ل Bash في Azure Cloud Shell.

    

  • إذا كنت تفضل تشغيل أوامر مرجع CLI محلياً قم بتثبيت CLI Azure. إذا كنت تعمل على نظام تشغيل Windows أو macOS، ففكر في تشغيل Azure CLI في حاوية Docker. لمزيد من المعلومات، راجع كيفية تشغيل Azure CLI في حاوية Docker.

    • إذا كنت تستخدم تثبيت محلي، يُرجى تسجيل الدخول إلى Azure CLI مستخدمًا أمر az login. لإنهاء عملية المصادقة، اتبع الخطوات المعروضة في جهازك. للحصول على خيارات أخرى لتسجيل دخول، راجع تسجيل الدخول باستخدام Azure CLI.

    • عندما يُطلب منك، قم بتثبيت ملحق Azure CLI عند الاستخدام لأول مرة. لمزيد من المعلومات بشأن الامتدادات، راجع استخدام امتدادات مع Azure CLI.

    • يُرجى تشغيل إصدار az للوصول إلى الإصدار والمكتبات التابعة التي تم تثبيتها. للتحديث لآخر إصدار، يُرجى تشغيل تحديث az.

• Azure PowerShell

  • إذا اخترت استخدام Azure PowerShell محليا:
    • تثبيت أحدث إصدار من الوحدة النمطية Az PowerShell.
    • اتصل بحساب Azure الخاص بك باستخدامConnect-AzAccount cmdlet.
  • إذا اخترت استخدام Azure Cloud Shell:
    • لمزيد من المعلومات، راجع نظرة عامة على Azure Cloud Shell.

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

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="my-graphql-api"
APIPath="myapi"
DisplayName="MyGraphQLAPI"
SpecificationFormat="GraphQL"
SpecificationURL="<GraphQL backend endpoint>"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --display-name $DisplayName --specification-format $SpecificationFormat --specification-url $SpecificationURL

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details
$apiId = "my-graphql-api"
$apiPath = "myapi"
$specificationFormat = "GraphQL"
$specificationUrl = "<GraphQL backend endpoint>"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath

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

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

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

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

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

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

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

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

7. ضمن محرر الاستعلام، إما:

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

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

      

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

9. حدد إرسال.

10. عرض الرد.

    

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

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

اختبار اشتراك

إذا كانت واجهة برمجة تطبيقات GraphQL تدعم اشتراكا، يمكنك اختباره في وحدة تحكم الاختبار.

1. تأكد من أن واجهة برمجة التطبيقات تسمح بمخطط عنوان URL WebSocket (WS أو WSS) المناسب لواجهة برمجة التطبيقات الخاصة بك. يمكنك تمكين هذا الإعداد في علامة التبويب الإعدادات .

2. قم بإعداد استعلام اشتراك في محرر الاستعلام، ثم حدد Connect لإنشاء اتصال WebSocket بخدمة الواجهة الخلفية.

   

3. راجع تفاصيل الاتصال في جزء Subscription.

   

4. تظهر الأحداث المشتركة في جزء الاشتراك . يتم الاحتفاظ باتصال WebSocket حتى تقوم بفصله أو الاتصال باشتراك WebSocket جديد.

   

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

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

المواضيع ذات الصلة

• قيود استيراد API
• استيراد مواصفة OpenAPI
• استيراد واجهة برمجة تطبيقات SOAP
• استيراد واجهة برمجة تطبيقات SOAP وتحويلها إلى REST
• استيراد واجهة برمجة تطبيقات App Service
• استيراد واجهة برمجة تطبيقات تطبيق حاوية
• استيراد واجهة برمجة تطبيقات WebSocket
• استيراد واجهة برمجة تطبيقات GraphQL
• استيراد مخطط GraphQL وإعداد محللات الحقول
• تشغيل واجهة برمجة تطبيقات دالة Azure
• استيراد تطبيق Azure Logic
• استيراد خدمة Service Fabric
• استيراد واجهة برمجة تطبيقات Azure OpenAI
• استيراد واجهة برمجة تطبيقات OData
• استيراد بيانات التعريف لـ SAP OData
• استيراد واجهة برمجة تطبيقات gRPC
• تحرير واجهة برمجة تطبيقات

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