المراجعات في إدارة واجهة برمجة التطبيقات Azure

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

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

إشعار

بوابة المطور غير متوفرة في فئة الاستهلاك.

مع المراجعات، يمكنك:

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

ابدأ بالمراجعات باتباع الإرشادات التفصيلية الخاصة بنا.

الوصول إلى المراجعات المحددة

يمكن الوصول إلى كل مراجعة لواجهة برمجة التطبيقات الخاصة بك باستخدام عنوان URL تم تكوينه بشكل خاص. ;rev={revisionNumber} إلحاق في نهاية عنوان URL لواجهة برمجة التطبيقات، ولكن قبل سلسلة الاستعلام، للوصول إلى مراجعة محددة لواجهة برمجة التطبيقات هذه. على سبيل المثال، قد تستخدم عنوان URL هذا للوصول إلى المراجعة 3 من customers واجهة برمجة التطبيقات:

https://apis.contoso.com/customers;rev=3/leads?customerId=123

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

إشعار

;rev={id} يجب إلحاق معرف API، وليس مسار URI.

مراجعة حالية

يمكن تعيين مراجعة واحدة على أنها المراجعة الحالية . ستكون هذه المراجعة هي النسخة المستخدمة لجميع طلبات واجهة برمجة التطبيقات التي لا تحدد رقم مراجعة صريحاً في عنوان URL. يمكنك التراجع إلى مراجعة سابقة عن طريق تعيين تلك المراجعة على أنها حالية.

يمكنك تعيين مراجعة كحالية باستخدام مدخل Azure. إذا كنت تستخدم PowerShell، يمكنك استخدام New-AzApiManagementApiRelease cmdlet.

أوصاف المراجعة

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

عند تعيين مراجعة على أنها حالية، يمكنك أيضاً تحديد ملاحظة عامة بسجل التغيير اختيارياً. يتم تضمين سجل التغيير في بوابة المطور ليتمكن مستخدمو واجهة برمجة التطبيقات من عرضه. يمكنك تعديل ملاحظة سجل التغيير باستخدام Update-AzApiManagementApiRelease PowerShell cmdlet.

تنبيه

إذا كنت تقوم بتحرير مراجعة غير حالية لواجهة برمجة التطبيقات، فلا يمكنك تغيير الخصائص التالية:

• Name
• كتابة
• ‏‏الوصف
• الاشتراك مطلوب
• إصدار API
• وصف إصدار واجهة برمجة التطبيقات
• المسار
• البروتوكولات

يمكن تغيير هذه الخصائص فقط في المراجعة الحالية. إذا غيرت تعديلاتك أياً من الخصائص المذكورة أعلاه لمراجعة غير حالية، فسيتم عرض رسالة الخطأ Can't change property for non-current revision.

إجراء مراجعة دون اتصال

يمكن إجراء المراجعة في وضع عدم الاتصال، ما يجعلها غير قابلة للوصول إلى المتصلين حتى لو حاولوا الوصول إلى المراجعة من خلال عنوان URL الخاص بها. يمكنك وضع علامة على نسخة غير متصلة باستخدام مدخل Azure.

إشعار

نقترح إجراء المراجعات في وضع عدم الاتصال عند عدم استخدامها للاختبار.

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

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

إذا وجدت أن نسختك تحتوي على تغييرات متقطعة، أو إذا كنت ترغب في تحويل مراجعتك بشكل رسمي إلى نسخة تجريبية / تجريبية، يمكنك إنشاء نسخة من نسخة سابقة. باستخدام مدخل Microsoft Azure، انقر فوق 'Create Version from Revision' في قائمة سياق المراجعة في علامة التبويب Revisions.