مزامنة واجهات برمجة التطبيقات من Amazon API Gateway إلى Azure API Center (معاينة)
توضح هذه المقالة كيفية دمج Amazon API Gateway بحيث يتم تحديث واجهات برمجة التطبيقات للبوابة باستمرار في مخزون مركز واجهة برمجة التطبيقات.
حول دمج Amazon API Gateway
يتيح دمج Amazon API Gateway كمصدر واجهة برمجة تطبيقات لمركز واجهة برمجة التطبيقات الخاص بك المزامنة المستمرة بحيث يظل مخزون واجهة برمجة التطبيقات محدثا. يمكن ل Azure API Center أيضا مزامنة واجهات برمجة التطبيقات من مصادر بما في ذلك Azure API Management.
عند دمج Amazon API Gateway كمصدر لواجهة برمجة التطبيقات، يحدث ما يلي:
- تتم إضافة واجهات برمجة التطبيقات، وتعريفات واجهة برمجة التطبيقات (المواصفات) اختياريا، من بوابة واجهة برمجة التطبيقات إلى مخزون مركز واجهة برمجة التطبيقات.
- يمكنك تكوين بيئة من نوع Amazon API Gateway في مركز واجهة برمجة التطبيقات.
- يتم إنشاء نشر مقترن لكل تعريف واجهة برمجة تطبيقات متزامن.
المزامنة أحادية الاتجاه من Amazon API Gateway إلى مركز Azure API، ما يعني أن تحديثات واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات لا تتم مزامنتها مرة أخرى إلى Amazon API Gateway.
إشعار
- تكامل Amazon API Gateway قيد المعاينة حاليا.
- هناك حدود لعدد مصادر واجهة برمجة التطبيقات المتكاملة.
- تتم مزامنة واجهات برمجة التطبيقات في Amazon API Gateway مع مركز واجهة برمجة التطبيقات مرة واحدة في الساعة. تتم مزامنة واجهات برمجة تطبيقات REST فقط.
- كما تتم مزامنة تعريفات واجهة برمجة التطبيقات مع مركز واجهة برمجة التطبيقات إذا حددت خيار تضمينها أثناء التكامل. تتم مزامنة التعريفات من واجهات برمجة التطبيقات المنشورة فقط.
الكيانات المتزامنة من Amazon API Gateway
يمكنك إضافة خصائص بيانات التعريف والوثائق أو تحديثها إلى واجهات برمجة التطبيقات المتزامنة في مركز واجهة برمجة التطبيقات لمساعدة المساهمين على اكتشاف واجهات برمجة التطبيقات وفهمها واستهلاكها. تعرف على المزيد حول خصائص بيانات التعريف المضمنة والمخصصة لمركز Azure API.
يعرض الجدول التالي خصائص الكيان التي يمكن تعديلها في Azure API Center والخصائص التي تم تعيينها استنادا إلى قيمها في مصدر واجهة برمجة التطبيقات.
| الكيان | الخصائص القابلة للتكوين في مركز واجهة برمجة التطبيقات | الخصائص المحددة في مصدر واجهة برمجة التطبيقات المتكامل |
|---|---|---|
| واجهة برمجة التطبيقات (API) | الملخص. دورة الحياةStage termsOfService الترخيص مستند خارجي خصائص مخصصة |
العنوان الوصف النوع |
| إصدار API | دورة الحياةStage | العنوان التعريفات (إذا تمت مزامنتها) |
| البيئة | العنوان الوصف kind server.managementPortalUri الإعداد خصائص مخصصة |
server.type |
| التوزيع | العنوان الوصف الخادم state خصائص مخصصة |
server.runtimeUri |
إشعار
يتم إنشاء معرفات الموارد والنظام للكيانات المتزامنة مع Azure API Center تلقائيا ولا يمكن تغييرها.
المتطلبات الأساسية
مركز API في اشتراك Azure الخاص بك. إذا لم تكن قد أنشأت واحدا، فشاهد التشغيل السريع: إنشاء مركز واجهة برمجة التطبيقات.
مخزن مفاتيح Azure. إذا كنت بحاجة إلى إنشاء واحد، فشاهد التشغيل السريع: إنشاء مخزن مفاتيح باستخدام مدخل Microsoft Azure. لإضافة الأسرار أو إدارتها في key vault، يلزم على الأقل دور Key Vault Secrets Officer أو الأذونات المكافئة.
بوابة واجهة برمجة تطبيقات Amazon.
هوية مستخدم AWS IAM مع
AmazonAPIGatewayAdministratorالنهج المرفق.بالنسبة إلى 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. عند الحاجة بسبب بناء جملة متغير مختلف، يتم توفير أمثلة أوامر منفصلة للقذيفتين.
إنشاء مفاتيح وصول مستخدم IAM
لمصادقة مركز API الخاص بك إلى Amazon API Gateway، تحتاج إلى مفاتيح الوصول لمستخدم AWS IAM.
لإنشاء معرف مفتاح الوصول المطلوب والمفتاح السري باستخدام وحدة تحكم إدارة AWS، راجع إنشاء مفتاح وصول لنفسك في وثائق AWS.
احفظ مفاتيح الوصول في موقع آمن. ستقوم بتخزينها في Azure Key Vault في الخطوات التالية.
تنبيه
مفاتيح الوصول هي بيانات اعتماد طويلة الأجل، ويجب عليك إدارتها بأمان كما تفعل مع كلمة المرور. تعرف على المزيد حول تأمين مفاتيح الوصول
تخزين مفاتيح وصول مستخدم IAM في Azure Key Vault
تحميل مفتاحي وصول مستخدم IAM وتخزينهما يدويا في Azure Key Vault باستخدام التكوين الموصى به في الجدول التالي. لمزيد من المعلومات، راجع التشغيل السريع: تعيين سر واسترداده من Azure Key Vault باستخدام مدخل Microsoft Azure.
| سر AWS | خيارات التحميل | الاسم | قيمة سرية |
|---|---|---|---|
| مفتاح الوصول | يدوي | مفتاح الوصول إلى aws | معرف مفتاح الوصول الذي تم استرداده من AWS |
| مفتاح الوصول السري | يدوي | aws-secret-access-key | مفتاح الوصول السري الذي تم استرداده من AWS |
لاحظ المعرف السري لكل سر، وهو URI مشابه ل https://<key-vault-name>.vault.azure.net/secrets/<secret-name>. ستستخدم هذه المعرفات في الخطوات التالية.
تمكين هوية مدارة في مركز واجهة برمجة التطبيقات
بالنسبة لهذا السيناريو، يستخدم مركز API الخاص بك هوية مدارة للوصول إلى موارد Azure. بناء على احتياجاتك، قم بتمكين هوية مدارة معينة من قبل النظام أو هوية واحدة أو أكثر من الهويات المدارة المعينة من قبل المستخدم.
توضح الأمثلة التالية كيفية تمكين هوية مدارة معينة من قبل النظام باستخدام مدخل Azure أو Azure CLI. على مستوى عال، تتشابه خطوات التكوين مع الهوية المدارة المعينة من قبل المستخدم.
- في المدخل، انتقل إلى مركز API الخاص بك.
- في القائمة اليسرى، ضمن Security، حدد Managed identities.
- حدد النظام المعين، ثم قم بتعيين الحالة إلى تشغيل.
- حدد حفظ.
تعيين الهوية المدارة لدور مستخدم Key Vault Secrets
للسماح باستيراد واجهات برمجة التطبيقات، قم بتعيين الهوية المدارة لمركز واجهة برمجة التطبيقات لدور مستخدم Key Vault Secrets في مخزن مفاتيح Azure الخاص بك. يمكنك استخدام المدخل أو Azure CLI.
- في المدخل، انتقل إلى خزنة المفاتيح الخاصة بك.
- على الجانب الأيسر، حدد التحكم بالوصول (IAM).
- حدد + إضافة تعيين دور.
- في صفحة إضافة تعيين دور، قم بتعيين القيم كما يلي:
- في علامة التبويب Role ، حدد Key Vault Secrets User.
- في علامة التبويب الأعضاء، في تعيين الوصول إلى - حدد الهوية> المدارة + تحديد الأعضاء.
- في صفحة تحديد الهويات المدارة ، حدد الهوية المدارة المعينة من قبل النظام لمركز API الذي أضفته في القسم السابق. انقر فوق تحديد.
- حدد مراجعة + تعيين.
دمج بوابة واجهة برمجة تطبيقات Amazon
قم بتشغيل الأمر az apic integration create aws (preview) لدمج Amazon API Gateway في مركز API الخاص بك.
قم بتوفير أسماء مجموعة الموارد ومركز واجهة برمجة التطبيقات والتكامل.
قم بتوفير المعرفات السرية ل Key Vault لمفتاح الوصول إلى AWS ومفتاح الوصول السري، ومنطقة AWS حيث يتم نشر Amazon API Gateway.
az apic integration create aws \
--resource-group <resource-group-name> \
--service-name-name <api-center-name> \
--integration-name <aws-integration-name> \
--aws-access-key-reference <access-key-uri> \
--aws-secret-access-key-reference <secret-access-key-uri>
--aws-region-name <aws-region>
تتم إضافة البيئة في مركز API الخاص بك. يتم استيراد واجهات برمجة تطبيقات بوابة Amazon إلى مخزون مركز واجهة برمجة التطبيقات.
حذف تكامل
أثناء دمج مصدر واجهة برمجة التطبيقات، لا يمكنك حذف واجهات برمجة التطبيقات المتزامنة من مركز واجهة برمجة التطبيقات. إذا كنت بحاجة إلى ذلك، يمكنك حذف التكامل. عند حذف تكامل:
- يتم حذف واجهات برمجة التطبيقات المتزامنة في مخزون مركز واجهة برمجة التطبيقات
- يتم حذف البيئة والنشرات المقترنة بمصدر واجهة برمجة التطبيقات
لحذف تكامل باستخدام Azure CLI، قم بتشغيل الأمر az apic integration delete (preview). قم بتوفير أسماء مجموعة الموارد ومركز واجهة برمجة التطبيقات والتكامل.
az apic integration delete \
--resource-group <resource-group-name> \
--service-name <api-center-name> \
--integration-name <integration-name>