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

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

هناك أوقات يكون فيها من غير العملي أن يستخدم جميع المستدعين بواجهة برمجة التطبيقات نفس الإصدار بالضبط. عندما يرغب المستدعون في الترقية إلى إصدار أحدث، فإنهم يريدون نهجًا يسهل فهمه. كما هو موضح في هذا البرنامج التعليم، يمكن تقديم عدة إصداراتفي Azure API Management.

للحصول على الخلفية، راجع الإصدارات والمراجعات.

في هذا البرنامج التعليمي، تتعلم كيفية:

• إضافة إصدار جديد إلى واجهة برمجة تطبيقات موجودة
• اختيار مخطط إصدار
• أضف الإصدار إلى أحد المنتجات
• تصفح مدخل المطور للاطلاع على الإصدار

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

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

إضافة إصدار جديد

1. في مدخل Azure، انتقل إلى مثيل API Management الخاص بك.
2. تحديد APIs.
3. تحديد Demo Conference API من قائمة واجهة برمجة التطبيقات.
4. حدد قائمة السياق (...) بجوار Demo Conference API.
5. حدد إضافة إصدار.

تلميح

كما يمكن تمكين الإصدارات عند إنشاء واجهة برمجة تطبيقات جديدة. على الشاشة إضافة واجهة برمجة التطبيقات، حدد إصدار واجهة برمجة التطبيقات هذه؟.

اختيار مخطط إصدار

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

أدخل القيم من الجدول التالي. ثم حدد إنشاء لإنشاء إصدارك.

الإعداد	قيمة	‏‏الوصف
الاسم	demo-conference-api-v1	اسم فريد في مثيل API Management الخاص بك. لأن إصدار هو في الواقع واجهة برمجة التطبيقات جديدة تستند إلى مراجعة واجهة برمجة التطبيقات، هذا الإعداد هو اسم واجهة برمجة التطبيقات الجديد.
مخطط إصدار	مسار	طريقة تحديد المستدعين لإصدار API.
معرف الإصدار	v1	مؤشر خاص بالمخطط الخاص بالإصدار. بالنسبة لـ المسار، لاحقة مسار واجهة برمجة التطبيقات لعنوان URL. إذا تم تحديد سلسلة الرأس أو الاستعلام، أدخل قيمة إضافية: اسم معلمة سلسلة الرأس أو الاستعلام. يتم عرض مثال استخدام.
المنتجات	غير محدود	اختياريًا، منتج واحد أو أكثر مقترنة بإصدار واجهة برمجة التطبيقات. لنشر واجهة برمجة التطبيقات، يجب إقرانه بمنتج. يمكنك أيضًا إضافة الإصدار إلى منتج لاحقًا.

بعد إنشاء الإصدار، يظهر الآن تحت Demo Conference API في قائمة واجهة برمجة التطبيقات. ترى الآن اثنتين من واجهات برمجة التطبيقات: الأصلي، وv1.

إشعار

إذا قمت بإضافة إصدار إلى واجهة برمجة التطبيقات غير إصدار، يتم إنشاء الأصل تلقائيًا أيضًا. يستجيب هذا الإصدار على عنوان URL الافتراضي. يضمن إنشاء إصدار أصلي عدم قطع أي من المستدعين الموجودين بسبب عملية إضافة إصدار. إذا قمت بإنشاء واجهة برمجة تطبيقات جديدة مع تمكين الإصدارات في البداية، لا يتم إنشاء الأصل.

تحرير إصدار

بعد إضافة الإصدار، يمكنك الآن تحريره وتكوينه كواجهة برمجة تطبيقات منفصلة عن الإصدار الأصلي. لا تؤثر التغييرات على إصدار آخر. على سبيل المثال، إضافة عمليات API أو إزالتها أو تحرير مواصفات OpenAPI. لمزيدٍ من المعلومات، راجع Edit an API.

أضف الإصدار إلى أحد المنتجات

لكي يرى المستدعون الإصدار الجديد، يجب إضافته إلى منتج. إذا لم تكن قد أضفت الإصدار إلى منتج، فيمكنك إضافته إلى منتج في أي وقت.

على سبيل المثال، لإضافة الإصدار إلى المنتج غير المحدود:

1. في مدخل Azure، انتقل إلى مثيل API Management.
2. حدد إضافة واجهات>برمجةالتطبيقات غير >المحدودة >+ للمنتجات.
3. حدد Demo Conference API، الإصدار v1.
4. انقر فوق تحديد.

استخدام مجموعات الإصدار

عند إنشاء إصدارات متعددة، ينشئ مدخل Azure مجموعة إصدارات، والتي تمثل مجموعة من الإصدارات لواجهة برمجة التطبيقات منطقية واحدة. حدد اسم واجهة برمجة التطبيقات الذي يحتوي على إصدارات متعددة. يعرض مدخل Azure مجموعة الإصدار الخاصة به. يمكنك تخصيص الاسم والوصف للمجموعة الظاهرية.

يمكنك التفاعل مباشرة مع مجموعات الإصدار باستخدام CLI Azure:

• استخدم بيئة 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 apim api versionset list:

az apim api versionset list --resource-group apim-hello-world-resource-group \
    --service-name apim-hello-world --output table

عندما ينشئ مدخل Azure إصدارًا تم تعيينه لك، فإنه يعين اسمًا أبجديًا رقميًا، يظهر في عمود الاسم في القائمة. استخدم هذا الاسم في أوامر Azure CLI أخرى.

لمشاهدة تفاصيل حول مجموعة إصدار، قم بتشغيل الأمر az apim api versionset show:

az apim api versionset show --resource-group apim-hello-world-resource-group \
    --service-name apim-hello-world --version-set-id 00000000000000000000000

لمزيد من المعلومات حول مجموعات الإصدارات، راجع الإصدارات في Azure API Management.

تصفح مدخل المطور للاطلاع على الإصدار

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

1. تحديد مدخل المطور من القائمة العلوية.
2. في مدخل المطور، تحديد واجهات برمجة التطبيقات، ثم تحديد Demo Conference API.
3. يجب أن تشاهد القائمة المنسدلة بإصدارات متعددة بجانب اسم واجهة برمجة التطبيقات.
4. تحديد v1.
5. لاحظ عنوان URL الخاص بالطلب العملية الأولى في القائمة. يُظهر أن مسار واجهة برمجة التطبيقات لعنوان URL يتضمن v1.

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

في هذا البرنامج التعليمي، نتعلم طريقة القيام بما يأتي:

• إضافة إصدار جديد إلى واجهة برمجة تطبيقات موجودة
• اختيار مخطط إصدار
• أضف الإصدار إلى أحد المنتجات
• تصفح مدخل المطور للاطلاع على الإصدار

تقدم إلى البرنامج التعليمي الآتي:

تخصيص نمط صفحات مدخل المطور