إشعار
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تسجيل الدخول أو تغيير الدلائل.
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تغيير الدلائل.
يتضمن مركز واجهة برمجة التطبيقات في مؤسستك قدرات مداخلة تديرها Microsoft لتحليل تعريفات واجهات برمجة التطبيقات للالتزام بقواعد أسلوب المنظمة، مما يولد تقارير فردية وملخصة. يحدد تحليل واجهة برمجة التطبيقات الأخطاء الشائعة والتناقضات في تعريفات واجهة برمجة التطبيقات الخاصة بك ويساعدك على تصحيحها.
مع تحليل واجهة برمجة التطبيقات:
- يحلل Azure API Center تلقائيا تعريفات واجهة برمجة التطبيقات الخاصة بك كلما قمت بإضافة تعريف واجهة برمجة التطبيقات أو تحديثه. يتم تنفيذ الخطوط التعريفية لتعريفات واجهات برمجة التطبيقات بشكل افتراضي باستخدام
spectral:oasمجموعة قواعد (دليل أنماط API). - يتم إنشاء تقارير تحليل واجهة برمجة التطبيقات في مدخل Microsoft Azure، توضح كيفية توافق تعريفات واجهة برمجة التطبيقات مع دليل الأنماط.
- استخدم ملفات تعريف التحليل لتحديد مجموعة القواعد وشروط التصفية لواجهات برمجة التطبيقات التي يتم تحليلها. تخصيص مجموعة قواعد ملف تعريف باستخدام إضافة Azure API Center ل تعليمة Visual Studio برمجية.
هام
إذا كنت تفضل ذلك، يمكنك تمكين التحليل والتحليل المدار ذاتيا باستخدام دالة Azure مخصصة، ما يتجاوز القدرات المضمنة. قم بتعطيل أي دالة مستخدمة للتحليل المدار ذاتيا قبل استخدام تحليل واجهة برمجة التطبيقات المدارة.
القيود
- حاليا، يتم تحليل مستندات مواصفات OpenAPI وAsyncAPI بتنسيق JSON أو YAML فقط.
- هناك حدود لعدد ملفات التحليل وأقصى عدد لتعريفات واجهات برمجة التطبيقات التي تم تحليلها. قد يستغرق التحليل بضع دقائق حتى 24 ساعة حتى يكتمل.
المتطلبات الأساسية
- مركز API في اشتراك Azure الخاص بك. إذا لم يكن لديك واحد بالفعل، راجع Quickstart: إنشاء مركز API الخاص بك.
- لتخصيص مجموعة القواعد وVisual Studio Code وملحقات تعليمة Visual Studio برمجية التالية:
عرض تقارير تحليل واجهة برمجة التطبيقات
عرض ملخص تحليل وتقارير التحليل لتعريفات واجهة برمجة التطبيقات في مدخل Microsoft Azure. بعد تحليل تعريفات واجهة برمجة التطبيقات، تسرد التقارير الأخطاء والتحذيرات والمعلومات استنادا إلى دليل نمط واجهة برمجة التطبيقات المكون.
في تقرير تحليل واجهة برمجة التطبيقات، راجع أيضا مجموعة القواعد التي تم استخدامها للتحليل وتاريخ تمريرات التحليل.
لعرض ملخص تحليل في مركز واجهة برمجة التطبيقات:
في المدخل، انتقل إلى مركز API الخاص بك.
في القائمة اليسرى، ضمن Governance، حدد API Analysis. يظهر الملخص.
حدد اختياريا أيقونة تقرير تحليل واجهة برمجة التطبيقات لتعريف واجهة برمجة التطبيقات. يظهر تقرير تحليل واجهة برمجة التطبيقات للتعريف، كما هو موضح في لقطة الشاشة التالية.
تلميح
يمكنك أيضا عرض تقرير تحليل واجهة برمجة التطبيقات عن طريق تحديد Analysis من شريط القوائم الخاص بتعريف واجهة برمجة التطبيقات.
إدارة ملفات تحليل الملفات
يستخدم مركز Azure API ملفات تعريف analysis لتغليف وتحليل واجهات برمجة التطبيقات. يحدد ملف التحليل مجموعة قواعد ومرشح شروط لواجهات برمجة التطبيقات التي يتم تحليلها اختياريا. ملف التحليل الافتراضي يطبق spectral:oas مجموعة القواعد على جميع تعريفات OpenAPI وAsyncAPI.
يمكنك تخصيص مجموعة القواعد وتحديد شروط التصفية في الملف الشخصي الافتراضي، أو يمكنك إنشاء ملف تعريف جديد. على سبيل المثال، قد ترغب في استخدام ملف تعريف واحد لواجهات برمجة التطبيقات التي هي قيد التطوير وملف آخر لواجهات برمجة التطبيقات الجارية في الإنتاج.
ملاحظة
في الخطة القياسية لمركز API، يمكنك إنشاء ما يصل إلى ثلاثة ملفات تحليل. يدعم ملف تعريف واحد فقط في الخطة المجانية.
لإنشاء ملف تحليلي:
- في مدخل Microsoft Azure، انتقل إلى مركز واجهة برمجة التطبيقات الخاص بك.
- في القائمة اليسرى، تحت الحوكمة، اختر تحليل> واجهة برمجة التطبيقاتإدارة ملفات تعريف> التحليل+ إنشاء ملف تحليل.
- في صفحة إنشاء ملف تعريف تحليلي جديد ، أدخل الاسموالوصف للملف الشخصي.
- في مجموعة القواعد، يظهر نوع المحلل (محرك الوبر) لمجموعة القواعد. حاليا فقط Spectral مدعوم.
- تحت تعريف شروط المرشح، أضف حالة أو أكثر من شروط المرشح لتعريفات واجهة برمجة التطبيقات التي يطبق عليها الملف الشخصي.
- حدد إنشاء.
يتم إنشاء الملف الشخصي وإنشاء هيكل قواعد (قاعدة قواعد). لعرض مجموعة القواعد الحالية، اختر الملف الشخصي، وفي قائمة السياق (...) اختر عرض مجموعة القواعد.
لتخصيص مجموعة القواعد، تابع إلى الأقسام التالية.
تخصيص مجموعة قواعد الملف الشخصي
استخدم إضافة تعليمة Visual Studio برمجية ل Azure API Center لتخصيص مجموعة قواعد الملف الشخصي. بعد تخصيص مجموعة القواعد واختبارها محليا، يمكنك نشرها مرة أخرى في مركز واجهة برمجة التطبيقات الخاصة بك.
- في تعليمة Visual Studio برمجية، حدد أيقونة Azure API Center من شريط النشاط.
- في صفحة مركز الواجهات، قم بتوسيع مورد مركز واجهة المستخدم الذي تعمل عليه، ووسع ملفات التعريف (Profiles).
- قم بتوسيع الملف الشخصي الذي تريد تعديله، واختر
ruleset.yaml. - تعديل المحتوى أو استبداله حسب الحاجة.
- حفظ التغييرات إلى
ruleset.yaml.
اختبار مجموعة القواعد محليا
قبل نشر مجموعة القواعد المخصصة إلى مركز واجهة برمجة التطبيقات، تحقق من صحتها محليا. يوفر ملحق Azure API Center ل تعليمة Visual Studio برمجية دعما متكاملا لمواصفات واجهة برمجة التطبيقات مع التحليل الطيفي.
في تعليمة Visual Studio برمجية، استخدم اختصار لوحة المفاتيح Ctrl+Shift+P لفتح لوحة الأوامر.
اكتب Azure API Center: قم بتعيين دليل نمط واجهة برمجة التطبيقات النشط واضغط على Enter.
اختر تحديد ملف محلي وحدد
ruleset.yamlالملف الذي قمت بتخصيصه. اضغط على مفتاح الإدخال Enter.تجعل هذه الخطوة مجموعة القواعد المخصصة دليل النمط النشط لواجهة برمجة التطبيقات المحلية (linting).
الآن، عند فتح ملف تعريف واجهة برمجة التطبيقات المستندة إلى OpenAPI، يتم تشغيل عملية تحليل محلية تلقائيا في تعليمة Visual Studio برمجية. يتم عرض النتائج بشكل مضمن في المحرر وفي نافذة المشاكل (عرض > المشاكل أو Ctrl+Shift+M).
تلميح
يمكن لمطوري واجهة برمجة التطبيقات في مؤسستك أيضا استخدام إمكانية التحليل المحلية هذه للمساعدة في تحسين تعريفات واجهة برمجة التطبيقات الخاصة بهم قبل تسجيل واجهات برمجة التطبيقات في مركز واجهة برمجة التطبيقات.
راجع نتائج التحليل. قم بإجراء أي تعديلات ضرورية على مجموعة القواعد وتابع اختبارها محليا حتى تنفذ بالطريقة التي تريدها.
توزيع مجموعة القواعد إلى مركز واجهة برمجة التطبيقات
لنشر مجموعة القواعد المخصصة إلى مركز API الخاص بك:
- في تعليمة Visual Studio برمجية، حدد أيقونة Azure API Center من شريط النشاط.
- في جزء API Center، قم بتوسيع مورد مركز واجهة برمجة التطبيقات الذي قمت بتخصيص مجموعة القواعد فيه.
- وسع الملفات الشخصية.
- انقر بزر الفأرة الأيمن على الملف الشخصي الذي خصصت فيه مجموعة القواعد، واختر "القواعد الناشئة في مركز واجهة برمجة التطبيقات".
تقوم رسالة بإعلامك بعد نشر القواعد بنجاح في مركز API الخاص بك. يستخدم محرك الواش مجموعة القواعد المحدثة لتحليل تعريفات واجهات برمجة التطبيقات في الملف الشخصي.
لمشاهدة نتائج التحليل باستخدام مجموعة القواعد المحدثة، اعرض تقارير تحليل واجهة برمجة التطبيقات في المدخل.
المحتوى ذو الصلة
- لمعرفة المزيد حول مجموعة القواعد المضمنة الافتراضية، راجع مستودع GitHub الطيفي.
- تمكين تحليل واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات - المدار ذاتيا