ملاحظة
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تسجيل الدخول أو تغيير الدلائل.
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تغيير الدلائل.
ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات
هناك حالات يكون فيها استخدام نفس الإصدار غير عملي لجميع مستهلكي واجهة برمجة التطبيقات. عندما يكون المستهلكون مستعدين للترقية إلى إصدار أحدث، فإنهم يفضلون نهجا بسيطا ومفهومة. كما هو موضح في هذا البرنامج التعليمي، تدعم Azure API Management الكشف عن إصدارات متعددة من واجهة برمجة التطبيقات لتلبية هذه الحاجة.
للحصول على الخلفية، راجع الإصدارات والمراجعات.
تلميح
يمكن لفرق واجهة برمجة التطبيقات استخدام هذه الميزة في مساحات العمل. توفر مساحات العمل وصولا إداريا معزولا إلى واجهات برمجة التطبيقات وبيئات وقت تشغيل واجهة برمجة التطبيقات الخاصة بها.
في هذا البرنامج التعليمي، تتعلم كيفية:
- إضافة إصدار جديد إلى واجهة برمجة تطبيقات موجودة
- اختيار مخطط إصدار
- أضف الإصدار إلى أحد المنتجات
- عرض الإصدار في مدخل المطور
المتطلبات الأساسية
- تعرف على مصطلحات Azure API Management.
- أكمل التشغيل السريع إنشاء مثيل إدارة واجهة برمجة تطبيقات Azure.
- أكمل البرنامج التعليمي استيراد ونشر واجهة برمجة التطبيقات الأولى.
إضافة إصدار جديد
- في مدخل Azure، انتقل إلى مثيل API Management الخاص بك.
- في القائمة اليسرى، في قسم واجهات برمجة التطبيقات ، حدد واجهات برمجة التطبيقات.
- حدد موقع Swagger Petstore - OpenAPI 3.0 في قائمة API. حدد علامة الحذف (...) بجوار Swagger Petstore - OpenAPI 3.0 ثم حدد Add version. ستضيف قيما إلى النافذة الناتجة في القسم التالي.
تلميح
يمكنك أيضا تمكين الإصدارات عند إنشاء واجهة برمجة تطبيقات جديدة. على الشاشة إضافة واجهة برمجة التطبيقات، حدد إصدار واجهة برمجة التطبيقات هذه؟.
اختيار مخطط إصدار
في APIM، يمكنك اختيار كيفية تحديد المتصلين لإصدار واجهة برمجة التطبيقات عن طريق تحديد نظام تعيين الإصدار: المسار أو الرأس أو سلسلة الاستعلام. في المثال التالي، يتم استخدام المسار كمخطط تعيين الإصدار.
في نافذة إنشاء واجهة برمجة تطبيقات جديدة كإصدار ، أدخل القيم من الجدول التالي. ثم حدد إنشاء لإنشاء إصدارك.
| الإعداد | قيمة | الوصف |
|---|---|---|
| معرف الإصدار | الإصدار 1 | مؤشر خاص بالمخطط الخاص بالإصدار. بالنسبة لـ المسار، لاحقة مسار واجهة برمجة التطبيقات لعنوان URL. |
| مخطط إصدار | مسار | طريقة تحديد المستدعين لإصدار API. إذا قمت بتحديد رأس أو سلسلة استعلام، أدخل قيمة أخرى: اسم معلمة الرأس أو سلسلة الاستعلام. يتم عرض مثال استخدام. |
| اسم إصدار API الكامل | swagger-petstore-openapi-3-0-v1 | اسم فريد في مثيل API Management الخاص بك. نظرا لأن الإصدار هو في الواقع واجهة برمجة تطبيقات جديدة تستند إلى مراجعة واجهة برمجة التطبيقات، فإن هذه القيمة هي اسم واجهة برمجة التطبيقات الجديدة. |
| المنتجات | غير محدود (متوفر في بعض مستويات الخدمة) | اختياريًا، منتج واحد أو أكثر مقترنة بإصدار واجهة برمجة التطبيقات. لنشر واجهة برمجة التطبيقات، يجب إقرانه بمنتج. يمكنك أيضًا إضافة الإصدار إلى منتج لاحقًا. |
بعد إنشاء الإصدار، يظهر ضمن Swagger Petstore - OpenAPI 3.0 في قائمة واجهة برمجة التطبيقات. ترى الآن اثنين من واجهات برمجة التطبيقات: الأصليةوv1:
إشعار
إذا أضفت إصدارا إلى واجهة برمجة تطبيقات غير إصدار، يتم أيضا إنشاء إصدار أصلي تلقائيا. يستجيب هذا الإصدار على عنوان URL الافتراضي. يضمن الإصدار الأصلي استمرار عمل المكالمات من المتصلين الحاليين بعد إضافة الإصدار. إذا قمت بإنشاء واجهة برمجة تطبيقات جديدة مع تمكين الإصدارات في البداية، فلن يتم إنشاء نسخة أصلية.
تحرير إصدار
بعد إضافة الإصدار، يمكنك تحريره وتكوينه كواجهة برمجة تطبيقات منفصلة عن الإصدار الأصلي. لا تؤثر التغييرات على إصدار واحد على إصدار آخر (على سبيل المثال، إذا قمت بإضافة عمليات واجهة برمجة التطبيقات أو إزالتها، أو تحرير مواصفات OpenAPI). لمزيدٍ من المعلومات، راجع Edit an API.
أضف الإصدار إلى أحد المنتجات
لكي يتمكن المتصلون من رؤية الإصدار الجديد، يجب إضافته إلى منتج. إذا لم تقم بالفعل بإضافة الإصدار إلى منتج، يمكنك القيام بذلك في أي وقت.
لإضافة الإصدار إلى منتج:
- في مدخل Azure، انتقل إلى مثيل API Management.
- ضمن واجهات برمجة التطبيقات في الجزء الأيمن، حدد المنتجات.
- حدد المنتج، ثم حدد واجهات برمجة التطبيقات في الجزء الأيمن.
- حدد + إضافة.
- حدد واجهة برمجة التطبيقات.
- انقر فوق تحديد.
استخدام مجموعات الإصدار
عند إنشاء إصدارات متعددة، ينشئ مدخل Azure مجموعة إصدارات، والتي تمثل مجموعة من الإصدارات لواجهة برمجة التطبيقات منطقية واحدة. إذا حددت اسم واجهة برمجة التطبيقات التي تحتوي على إصدارات متعددة، فسيعرض المدخل مجموعة الإصدارات الخاصة به. يمكنك تخصيص اسم مجموعة إصدار ووصفها.
يمكنك التفاعل مباشرة مع مجموعات الإصدار باستخدام CLI Azure:
استخدم بيئة 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.
لمشاهدة كافة مجموعات الإصدار الخاص بك، قم بتشغيل الأمر az apim api versionset list:
az apim api versionset list --resource-group <resource-group-name> \
--service-name <API-Management-service-name> --output table
عندما ينشئ مدخل Azure إصدارًا تم تعيينه لك، فإنه يعين اسمًا أبجديًا رقميًا، يظهر في عمود الاسم في القائمة. استخدم هذا الاسم في أوامر Azure CLI أخرى.
لمشاهدة تفاصيل حول مجموعة إصدار، قم بتشغيل الأمر az apim api versionset show:
az apim api versionset show --resource-group <resource-group-name> \
--service-name <API-Management-service-name> --version-set-id <ID from the Name column>
لمزيد من المعلومات حول مجموعات الإصدارات، راجع الإصدارات في Azure API Management.
عرض الإصدار في مدخل المطور
إذا كنت تستخدم مدخل المطور، يمكنك مشاهدة إصدارات واجهة برمجة التطبيقات هناك.
- حدد مدخل المطور في أعلى النافذة.
- حدد واجهات برمجة التطبيقات، ثم حدد Swagger Petstore.
- يجب أن تشاهد قائمة منسدلة تسرد إصدارات متعددة بجوار اسم واجهة برمجة التطبيقات.
- تحديد v1.
- لاحظ عنوان URL الخاص بالطلب العملية الأولى في القائمة. يُظهر أن مسار واجهة برمجة التطبيقات لعنوان URL يتضمن v1.
الخطوة التالية
انتقل إلى البرنامج التعليمي التالي: