استيراد مواصفة OpenAPI

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

توضح هذه المقالة كيفية استيراد واجهة برمجة تطبيقات خلفية "مواصفات OpenAPI" الموجودة في https://conferenceapi.azurewebsites.net?format=json. يتم توفير واجهة برمجة التطبيقات الخلفية هذه من قبل Microsoft واستضافتها على Azure. توضح المقالة أيضًا كيفية اختبار APIM API.

في هذه المقالة، ستتعرف على كيفية:

• استيراد مواصفات OpenAPI باستخدام مدخل Azure أو Azure CLI أو Azure PowerShell
• حدد التطبيق في مدخل Microsoft Azure

إشعار

يتم توثيق قيود استيراد واجهة برمجة التطبيقات في قيود استيراد واجهة برمجة التطبيقات والمشكلات المعروفة.

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

• مثيل API Management. إذا لم يكن لديك واحد بالفعل، فأكمل التشغيل السريع التالي: إنشاء مثيل إدارة واجهة برمجة تطبيقات Azure.

• 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.

استيراد واجهة برمجة تطبيقات خلفية

المدخل

1. في مدخل Azure، انتقل إلى مثيل API Management الخاص بك.

2. في القائمة اليسرى، حدد APIs>+ Add API.

3. ضمن Create from definition، حدد OpenAPI.

   

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

5. حدد إنشاء.

Azure CLI

يستخدم المثال التالي الأمر az apim api import لاستيراد مواصفات OpenAPI من عنوان URL المحدد إلى مثيل APIM المسمى apim-hello-world. للاستيراد باستخدام مسار إلى مواصفات بدلا من عنوان URL، استخدم المعلمة --specification-path .

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

# API-specific details
APIId="demo-conference-api"
APIPath="conference"
SpecificationFormat="OpenAPI"
SpecificationURL="https://conferenceapi.azurewebsites.net/?format=json"

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

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

بوويرشيل

يستخدم المثال التالي Import-AzApiManagementApi Azure PowerShell cmdlet لاستيراد مواصفات OpenAPI من عنوان URL المحدد إلى مثيل APIM المسمى apim-hello-world. للاستيراد باستخدام مسار إلى مواصفات بدلا من عنوان URL، استخدم المعلمة -SpecificationPath .

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

# API-specific details
$apiId = "demo-conference-api"
$apiPath = "conference"
$specificationFormat = "OpenAPI"
$specificationUrl = "https://conferenceapi.azurewebsites.net/?format=json"

# 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

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

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

يمكن استدعاء العمليات مباشرة من المدخل، ما يوفر طريقة ملائمة للمسؤولين لعرض عمليات واجهة برمجة التطبيقات واختبارها.

1. تحديد واجهة برمجة التطبيقات التي أنشأتها في الخطوة السابقة.

2. حدد علامة التبويب الاختبار.

3. حدد عملية. تعرض الصفحة الحقول لمعلمات الاستعلام وحقول الرؤوس.

   إشعار

   في وحدة تحكم الاختبار، تقوم APIM تلقائيا بتعبئة عنوان Ocp-Apim-Subscription-Key، وتكوين مفتاح الاشتراك للاشتراك المضمن في الوصول بالكامل. يتيح هذا المفتاح الوصول إلى كل واجهة برمجة تطبيقات في مثيل APIM. عرض رأس Ocp-Apim-Subscription-Key اختياريا عن طريق تحديد أيقونة "العين" بجوار طلب HTTP.

4. اعتمادا على العملية، أدخل قيم معلمات الاستعلام أو قيم الرأس أو نص الطلب. حدد إرسال.

   عند نجاح الاختبار، تستجيب الخلفية برمز استجابة HTTP ناجح وبعض البيانات.

   تلميح

   بشكل افتراضي، ترسل وحدة التحكم في الاختبار طلبا إلى وكيل CORS الخاص بإدارة واجهة برمجة التطبيقات، والذي يعيد توجيه الطلب إلى مثيل APIM، والذي يعيد توجيهه بعد ذلك إلى الخلفية. يستخدم هذا الوكيل عنوان IP العام 13.91.254.72 ويمكنه الوصول إلى نقاط النهاية العامة فقط. إذا كنت ترغب في إرسال طلب مباشرة من المستعرض إلى خدمة APIM، فحدد تجاوز وكيل CORS. استخدم هذا الخيار عندما تريد استخدام وحدة تحكم الاختبار وكانت بوابة APIM الخاصة بك معزولة عن الشبكة أو لا تسمح بنسبة استخدام الشبكة من وكيل CORS.

لتصحيح أخطاء واجهة برمجة التطبيقات، راجع البرنامج التعليمي: تصحيح واجهات برمجة التطبيقات باستخدام تتبع الطلب.

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

يمكنك إنشاء واجهة برمجة تطبيقات من واجهات برمجة التطبيقات التي تعرضها الخدمات المختلفة، وتشمل:

• مواصفات OpenAPI
• واجهة برمجة تطبيقات SOAP
• واجهة برمجة تطبيقات GraphQL
• Web App مستضاف في Azure App Service
• تطبيق الوظائف Azure
• Azure Logic Apps
• Azure Service Fabric

إلحاق واجهة برمجة تطبيقات أخرى بتلك الحالية باتباع الخطوات التالية.

إشعار

عند استيراد واجهة برمجة تطبيقات أخرى، يتم إلحاق العمليات بواجهة برمجة التطبيقات الحالية.

1. انتقل إلى مثيل Azure API Management في مدخل Azure.

   

2. حدّد واجهات برمجة التطبيقات في الصفحة نظرة عامة أو من القائمة الموجودة إلى اليمين.

   

3. انقر فوق ... بجوار واجهة برمجة التطبيقات التي تريد إلحاق واجهة برمجة تطبيقات أخرى بها.

4. حدّد استيراد من القائمة المنسدلة.

   

5. حدّد خدمة لاستيراد واجهة برمجة تطبيقات منها.

   

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

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

التحقق من الصحة مقابل مواصفات OpenAPI

يمكنك تكوين نهج التحقق من صحة إدارة واجهة برمجة التطبيقات للتحقق من صحة الطلبات والاستجابات (أو عناصر منها) مقابل المخطط في مواصفات OpenAPI. على سبيل المثال، استخدم نهج التحقق من صحة المحتوى للتحقق من حجم أو محتوى طلب أو نص استجابة.

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

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