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

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

إشعار

مع التحليل والتحليل المدارين، يقوم مركز واجهة برمجة التطبيقات بإعداد محرك تحليل وأي تبعيات ومشغلات مطلوبة. يمكنك أيضا تمكين التحليل والتحليل يدويا.

في هذا السيناريو:

1. أضف مجموعة قواعد التحليل (دليل نمط واجهة برمجة التطبيقات) في مركز واجهة برمجة التطبيقات باستخدام ملحق Visual Studio Code لمركز واجهة برمجة تطبيقات Azure.
2. يقوم Azure API Center تلقائيا بتشغيل التحليل عند إضافة تعريف واجهة برمجة التطبيقات أو تحديثه. يتم تشغيله أيضا لجميع تعريفات واجهة برمجة التطبيقات عند نشر مجموعة قواعد إلى مركز API الخاص بك.
3. راجع تقارير تحليل واجهة برمجة التطبيقات في مدخل Microsoft Azure لمعرفة كيفية توافق تعريفات واجهة برمجة التطبيقات مع دليل الأنماط.
4. تخصيص مجموعة القواعد لواجهات برمجة تطبيقات مؤسستك اختياريا. اختبر مجموعة القواعد المخصصة محليا قبل نشرها في مركز واجهة برمجة التطبيقات.

القيود

• حاليا، يتم تحليل مستندات مواصفات OpenAPI بتنسيق JSON أو YAML فقط.
• بشكل افتراضي، يمكنك تمكين التحليل باستخدام spectral:oas مجموعة القواعد. لمعرفة المزيد حول القواعد المضمنة، راجع مستودع GitHub الطيفي.
• حاليا، تقوم بتكوين مجموعة قواعد واحدة، ويتم تطبيقها على جميع تعريفات OpenAPI في مركز API الخاص بك.

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

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

• Visual Studio Code

• ملحقات Visual Studio Code التالية:

  • ملحق Azure API Center ل Visual Studio Code

    هام

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

  • ملحق طيفي ل Visual Studio Code

تمكين تحليل واجهة برمجة التطبيقات باستخدام Visual Studio Code

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

1. في Visual Studio Code، افتح مجلدا ستستخدمه لإدارة مجموعات القواعد ل Azure API Center.

2. حدد أيقونة Azure API Center من شريط النشاط.

3. في جزء API Center، قم بتوسيع مورد مركز واجهة برمجة التطبيقات لتمكين تحليل واجهة برمجة التطبيقات.

4. انقر بزر الماوس الأيمن فوق Rules وحدد Enable API Analysis.

   

تعلمك الرسالة بعد تمكين تحليل واجهة برمجة التطبيقات بنجاح. يتم إنشاء مجلد لمركز API الخاص بك في .api-center-rules، في جذر مجلد العمل الخاص بك. يحتوي المجلد الخاص بمركز واجهة برمجة التطبيقات على:

• ruleset.yml ملف يحدد دليل نمط واجهة برمجة التطبيقات الافتراضي المستخدم من قبل محرك التحليل.
• functions مجلد يحتوي على مثال دالة مخصصة يمكنك استخدامها لتوسيع مجموعة القواعد.

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

عرض تقارير تحليل واجهة برمجة التطبيقات

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

لعرض ملخص تحليل في مركز واجهة برمجة التطبيقات:

1. في المدخل، انتقل إلى مركز API الخاص بك.

2. في القائمة اليسرى، ضمن Governance، حدد API Analysis. يظهر الملخص.

   

3. حدد اختياريا أيقونة تقرير تحليل واجهة برمجة التطبيقات لتعريف واجهة برمجة التطبيقات. يظهر تقرير تحليل واجهة برمجة التطبيقات للتعريف، كما هو موضح في لقطة الشاشة التالية.

   

   تلميح

   يمكنك أيضا عرض تقرير تحليل واجهة برمجة التطبيقات عن طريق تحديد Analysis من شريط القوائم الخاص بتعريف واجهة برمجة التطبيقات.

تخصيص مجموعة القواعد

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

لتخصيص مجموعة القواعد أو استبدالها:

1. في Visual Studio Code، افتح .api-center-rules المجلد في جذر مجلد العمل.
2. في المجلد الخاص بمورد مركز واجهة برمجة التطبيقات، افتح ruleset.yml الملف.
3. تعديل المحتوى أو استبداله حسب الحاجة.
4. حفظ التغييرات إلى ruleset.yml.

اختبار مجموعة القواعد محليا

قبل نشر مجموعة القواعد المخصصة إلى مركز واجهة برمجة التطبيقات، تحقق من صحتها محليا. يوفر ملحق Azure API Center ل Visual Studio Code دعما متكاملا لمواصفات واجهة برمجة التطبيقات مع التحليل الطيفي.

1. في Visual Studio Code، استخدم اختصار لوحة المفاتيح Ctrl+Shift+P لفتح لوحة الأوامر.

2. اكتب Azure API Center: قم بتعيين دليل نمط واجهة برمجة التطبيقات النشط واضغط على Enter.

3. اختر تحديد ملف محلي وحدد ruleset.yml الملف الذي قمت بتخصيصه. اضغط على مفتاح الإدخال Enter.

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

الآن، عند فتح ملف تعريف واجهة برمجة التطبيقات المستندة إلى OpenAPI، يتم تشغيل عملية تحليل محلية تلقائيا في Visual Studio Code. يتم عرض النتائج بشكل مضمن في المحرر وفي نافذة المشاكل (عرض > المشاكل أو Ctrl+Shift+M).

راجع نتائج التحليل. قم بإجراء أي تعديلات ضرورية على مجموعة القواعد وتابع اختبارها محليا حتى تنفذ بالطريقة التي تريدها.

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

لنشر مجموعة القواعد المخصصة إلى مركز API الخاص بك:

1. في Visual Studio Code، حدد أيقونة Azure API Center من شريط النشاط.
2. في جزء API Center، قم بتوسيع مورد مركز واجهة برمجة التطبيقات الذي قمت بتخصيص مجموعة القواعد فيه.
3. انقر بزر الماوس الأيمن فوق Rules وحدد Deploy Rules to API Center.

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

لمشاهدة نتائج التحليل باستخدام مجموعة القواعد المحدثة، اعرض تقارير تحليل واجهة برمجة التطبيقات في المدخل.

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

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