مشاركة عبر


Azure API Center - المفاهيم الرئيسية

استكشف المفاهيم الرئيسية ل Azure API Center، الذي يتيح لك تتبع واجهات برمجة التطبيقات في موقع مركزي للاكتشاف وإعادة الاستخدام والحوكمة.

نموذج البيانات

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

يوضح الرسم البياني التالي الكيانات الرئيسية وكيف ترتبط ببعضها البعض.

رسم بياني يوضح الميزات الرئيسية لنموذج البيانات في Azure API Center.

واجهة برمجة التطبيقات (API)

كيان منطقي من المستوى الأعلى في Azure API Center، تمثل واجهة برمجة التطبيقات أي واجهة برمجة تطبيقات في العالم الحقيقي تريد تعقبها. يمكن أن يتضمن مركز واجهة برمجة التطبيقات واجهات برمجة التطبيقات من أي نوع، بما في ذلك REST وGraphQL وgRPC وصابون وWebSocket وWebhook.

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

يمكن لمديري برامج API أو مسؤولي تقنية المعلومات إنشاء وإدارة مخزون API في Azure API Center. يتضمن Azure API Center أيضا ميزات لمطوري واجهة برمجة التطبيقات لتسجيل تعريفات واجهة برمجة التطبيقات مباشرة من بيئات التطوير الخاصة بهم، مثل Visual Studio Code أو مسارات CI/CD.

إصدار API

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

تعريف واجهة المستخدم

يجب أن يكون هناك تعريف واحد على الأقل لكل إصدار من واجهة برمجة التطبيقات، مثل تعريف OpenAPI لواجهة برمجة تطبيقات REST. يسمح Azure API Center بأي ملف تعريف API منسق كنص (YAML وJSON و Markdown وما إلى ذلك). يمكنك تحميل تعريفات OpenAPI وgRPC وGraphQL وAsyncAPI وWSDL وWADL، من بين تعريفات أخرى.

للمساعدة في إدارة واجهة برمجة التطبيقات، يوفر Azure API Center قدرات التحليل لتحليل تعريفات واجهة برمجة التطبيقات للجودة والتوافق مع المعايير التنظيمية.

البيئة

تمثل البيئة موقعا يمكن فيه نشر وقت تشغيل API مثل خدمة إدارة API في Azure أو خدمة إدارة API Apigee. قد تقوم أيضا بنشرها على خدمة حوسبة مثل عنقود Kubernetes أو تطبيق ويب أو تطبيق Azure Functions. تتم محاذاة كل بيئة مع مرحلة دورة حياة مثل التطوير أو الاختبار أو التقسيم المرحلي أو الإنتاج. قد تتضمن البيئة أيضا معلومات حول بوابة المطورين أو واجهات الإدارة.

إشعار

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

التوزيع

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

بيانات التعريف

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

يدعم Azure API Center بيانات التعريف المخصصة لصفيف النوع والقيمة والرقم والعنصر والخيارات المعرفة مسبقا والسلسلة.

يتوافق مخطط بيانات تعريف Azure API Center مع مواصفات مخطط JSON وYAML، للسماح بالتحقق من صحة المخطط في أدوات المطور والتدفقات التلقائية.