Azure API Center - المفاهيم الرئيسية
تشرح هذه المقالة المفاهيم الرئيسية ل Azure API Center. يتيح Azure API Center تتبع واجهات برمجة التطبيقات في موقع مركزي للاكتشاف وإعادة الاستخدام والحوكمة.
نموذج البيانات
يوضح الرسم التخطيطي التالي الكيانات الرئيسية في Azure API Center وكيفية ارتباطها ببعضها البعض. راجع الأقسام التالية لمزيد من المعلومات حول هذه الكيانات والمفاهيم ذات الصلة.
واجهة برمجة التطبيقات (API)
كيان منطقي من المستوى الأعلى في Azure API Center، تمثل واجهة برمجة التطبيقات أي واجهة برمجة تطبيقات في العالم الحقيقي تريد تعقبها. يمكن أن يتضمن مركز واجهة برمجة التطبيقات واجهات برمجة التطبيقات من أي نوع، بما في ذلك REST وGraphQL وgRPC وصابون وWebSocket وWebhook.
يمكن إدارة واجهة برمجة التطبيقات في المخزون بواسطة أي حل لإدارة واجهة برمجة التطبيقات، مثل Azure API Management أو Apigee API Management أو Kong Konnect أو MuleSoft API Management أو نظام أساسي آخر. يمكن أيضا أن تكون واجهة برمجة التطبيقات الممثلة في Azure API Center غير مدارة.
تم تصميم مخزون واجهة برمجة التطبيقات في Azure API Center ليتم إنشاؤه وإدارته من قبل مديري برامج واجهة برمجة التطبيقات أو مسؤولي تكنولوجيا المعلومات. يتضمن Azure API Center أيضا ميزات لمطوري واجهة برمجة التطبيقات لتسجيل تعريفات واجهة برمجة التطبيقات مباشرة من بيئات التطوير الخاصة بهم، مثل Visual Studio Code أو مسارات CI/CD.
إصدار API
تعيين إصدار واجهة برمجة التطبيقات هو ممارسة إدارة التغييرات على واجهة برمجة التطبيقات وضمان إجراء هذه التغييرات دون تعطيل العملاء. يمكن أن يكون لواجهة برمجة التطبيقات إصدارات متعددة عبر مراحل دورة الحياة، كل منها متوافق مع تغييرات محددة في واجهة برمجة التطبيقات. قد تقدم بعض الإصدارات تغييرات كبيرة أو فاصلة، بينما تضيف إصدارات أخرى تحسينات طفيفة. يمكن أن يكون إصدار واجهة برمجة التطبيقات في أي مرحلة من مراحل دورة الحياة - من التصميم، إلى المعاينة، أو الإنتاج، أو الإهمال.
تعريف واجهة المستخدم
يجب تعريف كل إصدار من إصدارات واجهة برمجة التطبيقات بشكل مثالي بواسطة تعريف واحد على الأقل، مثل تعريف OpenAPI لواجهة برمجة تطبيقات REST. يسمح Azure API Center بأي ملف تعريف API منسق كنص (YAML وJSON و Markdown وما إلى ذلك). يمكنك تحميل تعريفات OpenAPI وgRPC وGraphQL وAsyncAPI وWSDL وWADL، من بين تعريفات أخرى.
للمساعدة في إدارة واجهة برمجة التطبيقات، يوفر Azure API Center قدرات التحليل لتحليل تعريفات واجهة برمجة التطبيقات للجودة والتوافق مع المعايير التنظيمية.
البيئة
تمثل البيئة موقعا يمكن فيه نشر وقت تشغيل واجهة برمجة التطبيقات، على سبيل المثال، خدمة Azure API Management أو خدمة Apigee API Management أو خدمة حساب مثل مجموعة Kubernetes أو تطبيق ويب أو وظيفة Azure. تتم محاذاة كل بيئة مع مرحلة دورة حياة مثل التطوير أو الاختبار أو التقسيم المرحلي أو الإنتاج. قد تتضمن البيئة أيضا معلومات حول مدخل المطور أو واجهات الإدارة.
إشعار
استخدم Azure API Center لتعقب أي من بيئات وقت تشغيل واجهة برمجة التطبيقات، سواء كانت مستضافة على البنية الأساسية ل Azure أم لا. هذه البيئات ليست هي نفسها بيئات توزيع Azure.
التوزيع
التوزيع هو موقع (عنوان) حيث يمكن للمستخدمين الوصول إلى واجهة برمجة التطبيقات. يمكن أن يكون لواجهة برمجة التطبيقات عمليات نشر متعددة، مثل بيئات أو مناطق تشغيل مرحلي مختلفة. على سبيل المثال، يمكن أن يكون لواجهة برمجة التطبيقات نشر واحد في بيئة تشغيل مرحلي داخلية والثانية في بيئة إنتاج. يرتبط كل توزيع بتعريف API محدد.
بيانات التعريف
في Azure API Center، قم بتنظيم واجهات برمجة التطبيقات والنشرات والكيانات الأخرى عن طريق تعيين قيم بيانات التعريف، والتي يمكن استخدامها للبحث والتصفية وفرض معايير الحوكمة. يوفر مركز API العديد من خصائص بيانات التعريف المضمنة الشائعة مثل "نوع واجهة برمجة التطبيقات" و"مرحلة دورة الحياة". يمكن لمالك مركز API زيادة بيانات التعريف المضمنة عن طريق تعريف بيانات التعريف المخصصة في مخطط بيانات التعريف لتنظيم واجهات برمجة التطبيقات والنشرات والبيئات الخاصة بهم. على سبيل المثال، أنشئ خاصية الموافق على واجهة برمجة التطبيقات لتحديد الشخص المسؤول عن الموافقة على واجهة برمجة التطبيقات للاستخدام.
يدعم Azure API Center بيانات التعريف المخصصة لصفيف النوع والقيمة والرقم والعنصر والخيارات المعرفة مسبقا والسلسلة.
يتوافق مخطط بيانات تعريف Azure API Center مع مواصفات مخطط JSON وYAML، للسماح بالتحقق من صحة المخطط في أدوات المطور والتدفقات التلقائية.