استيراد واجهات برمجة التطبيقات إلى مركز API الخاص بك من Azure API Management

توضح هذه المقالة كيفية استيراد (إضافة) واجهات برمجة التطبيقات من مثيل إدارة واجهة برمجة تطبيقات Azure إلى مركز واجهة برمجة التطبيقات باستخدام Azure CLI. تساعد إضافة واجهات برمجة التطبيقات من API Management إلى مخزون واجهة برمجة التطبيقات على جعلها قابلة للاكتشاف والوصول إليها من قبل المطورين ومديري برامج واجهة برمجة التطبيقات وأصحاب المصلحة الآخرين في مؤسستك.

تعرض هذه المقالة خيارين لاستخدام Azure CLI لإضافة واجهات برمجة التطبيقات إلى مركز API الخاص بك من APIM:

• الخيار 1 - تصدير تعريف واجهة برمجة التطبيقات من مثيل APIM باستخدام الأمر az apim api export . ثم قم باستيراد التعريف إلى مركز API الخاص بك.

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

  • قم بتشغيل az apic api register لتسجيل واجهة برمجة تطبيقات جديدة في مركز API الخاص بك.
  • قم بتشغيل az apic api definition import-specification لاستيراد تعريف واجهة برمجة التطبيقات إلى واجهة برمجة تطبيقات موجودة.

• الخيار 2 - استيراد واجهات برمجة التطبيقات مباشرة من APIM إلى مركز واجهة برمجة التطبيقات باستخدام الأمر az apic import-from-apim .

بعد استيراد تعريفات واجهة برمجة التطبيقات أو واجهات برمجة التطبيقات من APIM، يمكنك إضافة بيانات التعريف والوثائق في مركز واجهة برمجة التطبيقات لمساعدة المساهمين على اكتشاف واجهة برمجة التطبيقات وفهمها واستهلاكها.

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

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

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

• واحد أو أكثر من واجهات برمجة التطبيقات المدارة في مثيل APIM الذي تريد إضافته إلى مركز API الخاص بك.

• بالنسبة إلى 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.

  إشعار

  az apic تتطلب apic-extension الأوامر ملحق Azure CLI. إذا لم تكن قد استخدمت az apic الأوامر، يمكن تثبيت الملحق ديناميكيا عند تشغيل الأمر الأول az apic ، أو يمكنك تثبيت الملحق يدويا. تعرف على المزيد حول ملحقات Azure CLI.

  راجع ملاحظات الإصدار للاطلاع على آخر التغييرات والتحديثات في apic-extension. قد تتطلب بعض الميزات معاينة أو إصدار معين من الملحق.

  إشعار

  يمكن تشغيل أمثلة أوامر Azure CLI في هذه المقالة في PowerShell أو bash shell. عند الحاجة بسبب بناء جملة متغير مختلف، يتم توفير أمثلة أوامر منفصلة للقذيفتين.

الخيار 1: تصدير تعريف واجهة برمجة التطبيقات من APIM واستيراده إلى مركز واجهة برمجة التطبيقات

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

تصدير واجهة برمجة التطبيقات إلى ملف تعريف API محلي

يقوم الأمر المثال التالي بتصدير واجهة برمجة التطبيقات مع المعرف my-api في مثيل myAPIManagement من واجهة برمجة التطبيقات. يتم تصدير واجهة برمجة التطبيقات بتنسيق OpenApiJson إلى ملف تعريف OpenAPI محلي في المسار الذي تحدده.

#! /bin/bash
az apim api export --api-id my-api --resource-group myResourceGroup \
    --service-name myAPIManagement --export-format OpenApiJsonFile \
    --file-path "/path/to/folder"

# Formatted for PowerShell
az apim api export --api-id my-api --resource-group myResourceGroup `
    --service-name myAPIManagement --export-format OpenApiJsonFile `
    --file-path '/path/to/folder'

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

في المثال التالي، يصدر az apim api export API مع المعرف my-api بتنسيق OpenApiJson إلى عنوان URL في تخزين Azure. يتوفر عنوان URL لمدة 5 دقائق تقريبا. هنا، يتم تخزين قيمة عنوان URL في متغير $link .

#! /bin/bash
link=$(az apim api export --api-id my-api --resource-group myResourceGroup \
    --service-name myAPIManagement --export-format OpenApiJsonUrl --query properties.value.link \
    --output tsv)

# Formatted for PowerShell
$link=$(az apim api export --api-id my-api --resource-group myResourceGroup `
    --service-name myAPIManagement --export-format OpenApiJsonUrl --query properties.value.link `
    --output tsv)

تسجيل واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات من تعريف واجهة برمجة التطبيقات المصدرة

يمكنك تسجيل واجهة برمجة تطبيقات جديدة في مركز API الخاص بك من التعريف المصدر باستخدام الأمر az apic api register .

يسجل المثال التالي واجهة برمجة تطبيقات في مركز myAPICenter API من ملف تعريف OpenAPI محلي يسمى definitionFile.json.

az apic api register --resource-group myResourceGroup --service-name myAPICenter --api-location "/path/to/definitionFile.json"

استيراد تعريف واجهة برمجة التطبيقات إلى واجهة برمجة تطبيقات موجودة في مركز واجهة برمجة التطبيقات

يستخدم المثال التالي الأمر az apic api definition import-specification لاستيراد تعريف API إلى واجهة برمجة تطبيقات موجودة في مركز myAPICenter API. هنا، يتم استيراد تعريف واجهة برمجة التطبيقات من عنوان URL مخزن في متغير $link .

يفترض هذا المثال أن لديك واجهة برمجة تطبيقات تسمى my-api وإصدار واجهة برمجة التطبيقات المقترن v1-0-0 وواجهة برمجة تطبيقات كيان التعريف في مركز واجهة برمجة التطبيقات الخاص بك. إذا لم تكن كذلك، فشاهد إضافة واجهات برمجة التطبيقات إلى مركز واجهة برمجة التطبيقات.

#! /bin/bash
az apic api definition import-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id my-api --version-id v1-0-0 \
    --definition-id openapi --format "link" --value '$link' \
    --specification '{"name":"openapi","version":"3.0.2"}'

# Formatted for PowerShell
az apic api definition import-specification `
    --resource-group myResourceGroup --service-name myAPICenter `
    --api-id my-api --version-id v1-0-0 `
    --definition-id openapi --format "link" --value '$link' `
    --specification '{"name":"openapi","version":"3.0.2"}'

الخيار 2: استيراد واجهات برمجة التطبيقات مباشرة من مثيل APIM

فيما يلي خطوات لاستيراد واجهات برمجة التطبيقات من مثيل APIM إلى مركز واجهة برمجة التطبيقات باستخدام الأمر az apic import-from-apim . يكون هذا الأمر مفيدا عندما تريد استيراد واجهات برمجة تطبيقات متعددة من APIM إلى مركز واجهة برمجة التطبيقات، ولكن يمكنك أيضا استخدامه لاستيراد واجهة برمجة تطبيقات واحدة.

عند إضافة واجهات برمجة التطبيقات من مثيل APIM إلى مركز API الخاص بك باستخدام az apic import-from-apim، يحدث ما يلي تلقائيا:

• يتم نسخ إصدارات وتعريفات ومعلومات النشر الخاصة بكل واجهة برمجة تطبيقات إلى مركز API الخاص بك.
• تتلقى واجهة برمجة التطبيقات اسم واجهة برمجة تطبيقات تم إنشاؤه بواسطة النظام في مركز واجهة برمجة التطبيقات. يحتفظ باسم العرض الخاص به (العنوان) من APIM.
• يتم تعيين مرحلة دورة حياة واجهة برمجة التطبيقات إلى تصميم.
• تتم إضافة Azure API Management كبيئة.

إضافة هوية مدارة في مركز واجهة برمجة التطبيقات

تمكين هوية مدارة في مركز واجهة برمجة التطبيقات

بالنسبة لهذا السيناريو، يستخدم مركز API الخاص بك هوية مدارة للوصول إلى موارد Azure. بناء على احتياجاتك، قم بتمكين هوية مدارة معينة من قبل النظام أو هوية واحدة أو أكثر من الهويات المدارة المعينة من قبل المستخدم.

توضح الأمثلة التالية كيفية تمكين هوية مدارة معينة من قبل النظام باستخدام مدخل Azure أو Azure CLI. على مستوى عال، تتشابه خطوات التكوين مع الهوية المدارة المعينة من قبل المستخدم.

az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'

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

للسماح باستيراد واجهات برمجة التطبيقات، قم بتعيين الهوية المدارة لمركز API دور قارئ خدمة إدارة واجهة برمجة التطبيقات في مثيل APIM الخاص بك. يمكنك استخدام المدخل أو Azure CLI.

استيراد واجهات برمجة التطبيقات من APIM

استخدم الأمر az apic import-from-apim لاستيراد واحد أو أكثر من واجهات برمجة التطبيقات من مثيل APIM إلى مركز API الخاص بك.

استيراد جميع واجهات برمجة التطبيقات من مثيل APIM

في الأمر التالي، استبدل أسماء مركز واجهة برمجة التطبيقات ومجموعة موارد مركز واجهة برمجة التطبيقات ومثيل APIM ومجموعة موارد المثيل الخاص بك. استخدم * لتحديد جميع واجهات برمجة التطبيقات من مثيل APIM.

#! /bin/bash
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> \
    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> \
    --apim-apis '*'  

# Formatted for PowerShell
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> `
    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> `
    --apim-apis '*'  

استيراد واجهة برمجة تطبيقات معينة من مثيل APIM

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

في الأمر التالي، استبدل أسماء مركز واجهة برمجة التطبيقات ومجموعة موارد مركز واجهة برمجة التطبيقات ومثيل APIM ومجموعة موارد المثيل الخاص بك. قم بتمرير اسم واجهة برمجة التطبيقات مثل petstore-api استخدام المعلمة --apim-apis .

#! /bin/bash
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> \
    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> \
    --apim-apis 'petstore-api'        

# Formatted for PowerShell
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> `
    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> `
    --apim-apis 'petstore-api'    

بعد استيراد واجهات برمجة التطبيقات من APIM، يمكنك عرض واجهات برمجة التطبيقات المستوردة وإدارتها في مركز API الخاص بك.

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

• مرجع Azure CLI ل Azure API Center
• مرجع Azure CLI لإدارة واجهة برمجة التطبيقات
• إدارة مخزون واجهة برمجة التطبيقات باستخدام أوامر Azure CLI
• تعيين أدوار Azure إلى هوية مدارة
• وثائق إدارة واجهات برمجة تطبيقات Azure