استيراد GraphQL API

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

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

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

• أضف واجهة برمجة تطبيقات GraphQL التمريرية إلى مثيل APIM الخاص بك.
• اختبر واجهة برمجة تطبيقات GraphQL الخاصة بك.

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

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

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

• Azure CLI، إذا كنت تريد استخدامه لاستيراد واجهة برمجة التطبيقات.

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

    

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

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

بوابة

1. في مدخل Microsoft Azure، انتقل إلى مثيل APIM.

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

3. حدد إضافة واجهة برمجة تطبيقات.

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

   

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

   

   Value	الوصف
   ‏‫اسم العرض‬	الاسم الذي ستُعرض به واجهة برمجة تطبيقات GraphQL.
   الاسم	الاسم الخام لواجهة برمجة تطبيقات GraphQL. يتم ملؤه تلقائيًا أثناء كتابة الاسم المعروض.
   نوع GraphQL	حدد Pass-through GraphQL للاستيراد من نقطة نهاية GraphQL API موجودة.
   نقطة نهاية واجهة برمجة تطبيقات GraphQL	عنوان URL الأساسي مع اسم نقطة نهاية واجهة برمجة تطبيقات GraphQL. على سبيل المثال: https://example.com/your-GraphQL-name. يمكنك أيضا استخدام نقطة نهاية SWAPI GraphQL شائعة مثل https://swapi-graphql.azure-api.net/graphql الغرض من العرض التوضيحي.
   مخطط التحميل	اختياريا ، حدد تحميل ملف المخطط الخاص بك لاستبدال المخطط الذي تم استرداده من نقطة نهاية GraphQL (إذا كان لديك واحد).
   الوصف	أضف وصفًا لواجهة برمجة التطبيقات الخاصة بك.
   مخطط URL	حدد نظاما استنادا إلى نقطة نهاية GraphQL. حدد أحد الخيارات التي تتضمن نظام WebSocket (WS أو WSS) إذا كانت واجهة برمجة تطبيقات GraphQL تتضمن نوع الاشتراك. التحديد الافتراضي هو HTTP(S).
   لاحقة عنوان URL لواجهة برمجة التطبيقات	أضف لاحقة عنوان URL لتحديد واجهة برمجة التطبيقات المحددة في مثيل إدارة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل إدارة واجهة برمجة التطبيقات.
   عنوان URL الأساسي	حقل غير قابل للتحرير يعرض عنوان URL الأساسي لواجهة برمجة التطبيقات.
   العلامات	اختياريا، قم بربط واجهة برمجة تطبيقات GraphQL الخاصة بك بعلامات جديدة أو حالية.
   المنتجات	اربط واجهة برمجة تطبيقات GraphQL الخاصة بك بمنتج لنشره.
   إصدار واجهة برمجة التطبيقات هذه؟	حدد خانة الاختيار لتطبيق مخطط تعيين الإصدار على واجهة برمجة تطبيقات GraphQL.

6. حدد إنشاء.

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

يستخدم المثال التالي الأمر az apim api import لاستيراد واجهة برمجة تطبيقات مرور GraphQL من عنوان URL المحدد إلى مثيل APIM المسمى apim-hello-world.

# Details specific to API Management instance.
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

بعد استيراد واجهة برمجة التطبيقات، يمكنك تحديث الإعدادات باستخدام الأمر az apim api update ، إذا كنت بحاجة إلى ذلك.

بوويرشيل

يستخدم المثال التالي Import-AzApiManagementApi Azure PowerShell cmdlet لاستيراد واجهة برمجة تطبيقات مرور GraphQL من عنوان URL المحدد إلى مثيل APIM المسمى apim-hello-world.

# Details specific to API Management instance.
$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

بعد استيراد واجهة برمجة التطبيقات، يمكنك تحديث الإعدادات باستخدام Set-AzApiManagementApi cmdlet، إذا كنت بحاجة إلى ذلك.

اختبر واجهة برمجة تطبيقات 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 وإعداد محللات الحقول
• استيراد واجهة برمجة تطبيقات تطبيق دالة
• استيراد واجهة برمجة تطبيقات تطبيق منطقي
• استيراد خدمة Service Fabric
• استيراد واجهة برمجة تطبيقات Azure الذكاء الاصطناعي Foundry
• استيراد واجهة برمجة تطبيقات Azure OpenAI
• استيراد واجهة برمجة تطبيقات LLM
• استيراد واجهة برمجة تطبيقات OData
• تصدير واجهة برمجة تطبيقات REST كخادم MCP
• كشف خادم MCP موجود
• استيراد واجهة برمجة تطبيقات وكيل A2A
• استيراد بيانات التعريف لـ SAP OData
• استيراد واجهة برمجة تطبيقات gRPC
• تحرير واجهة برمجة تطبيقات