إشعار
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تسجيل الدخول أو تغيير الدلائل.
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تغيير الدلائل.
يمكن لمطوري منتجي واجهة برمجة التطبيقات في مؤسستك إنشاء وتسجيل واجهات برمجة التطبيقات في مخزون مركز API الخاص بك باستخدام ملحق Azure API Center ل Visual Studio Code. يمكن لمطوري واجهة برمجة التطبيقات:
- أضف واجهة برمجة تطبيقات موجودة إلى مركز واجهة برمجة التطبيقات كلعملية لمرة واحدة، أو قم بدمج مسار تطوير لتسجيل واجهات برمجة التطبيقات كجزء من سير عمل CI/CD.
- استخدم GitHub Copilot لإنشاء مواصفات OpenAPI جديدة من التعليمات البرمجية لواجهة برمجة التطبيقات.
يمكن لمطوري مستهلكين واجهة برمجة التطبيقات أيضا الاستفادة من الميزات في الملحق لاكتشاف واجهات برمجة التطبيقات واستهلاكها في مركز واجهة برمجة التطبيقات وضمان إدارة واجهة برمجة التطبيقات.
المتطلبات الأساسية
مركز واحد أو أكثر من مراكز API في اشتراك Azure الخاص بك. يمكنك إنشاء مركز API باستخدام ملحق Azure API Center أو أدوات أخرى.
- حاليا، تحتاج إلى تعيين دور مساهم خدمة Azure API Center أو أذونات أعلى على مركز واجهة برمجة التطبيقات لإدارة واجهات برمجة التطبيقات باستخدام الملحق.
ملحقات Visual Studio Code التالية مطلوبة للسيناريوهات المحددة:
- إجراءات GitHub لتسجيل واجهات برمجة التطبيقات باستخدام مسار CI/CD مع إجراءات GitHub
- مسارات Azure لتسجيل واجهات برمجة التطبيقات باستخدام مسار CI/CD مع Azure Pipelines
- GitHub Copilot لإنشاء ملفات مواصفات OpenAPI من كود API
إعداد الملحق
تثبيت ملحق Azure API Center ل Visual Studio Code من Visual Studio Code Marketplace. تثبيت ملحقات أخرى حسب الحاجة.
إشعار
حيثما لوحظ، تتوفر بعض الميزات فقط في الإصدار التجريبي من ملحق Azure API Center. عند تثبيت الملحق من Visual Studio Code Marketplace، يمكنك اختيار تثبيت إصدار الإصدار أو إصدار ما قبل الإصدار. التبديل بين الإصدارين في أي وقت باستخدام قائمة سياق الزر إدارة للملحق في طريقة عرض الملحقات.
في Visual Studio Code، في شريط النشاط على اليسار، حدد API Center.
إذا لم تكن قد سجلت الدخول إلى حساب Azure الخاص بك، فحدد تسجيل الدخول إلى Azure...، واتبع المطالبات لتسجيل الدخول. حدد اشتراك Azure مع مركز واجهة برمجة التطبيقات (أو مراكز واجهة برمجة التطبيقات) الذي ترغب في عرض واجهات برمجة التطبيقات منه. يمكنك أيضا التصفية على اشتراكات محددة إذا كان لديك العديد من الاشتراكات للعرض منها.
تسجيل واجهة برمجة تطبيقات يدويا
تسجل الخطوات التالية واجهة برمجة تطبيقات في مركز واجهة برمجة التطبيقات كلعملية لمرة واحدة.
- استخدم اختصار لوحة المفاتيح Ctrl+Shift+P لفتح لوحة الأوامر. اكتب Azure API Center: تسجيل واجهة برمجة التطبيقات واضغط على Enter.
- حدد Manual.
- حدد مركز واجهة برمجة التطبيقات لتسجيل واجهات برمجة التطبيقات به.
- الرد على المطالبات بمعلومات بما في ذلك عنوان واجهة برمجة التطبيقات والنوع وعنوان الإصدار ودورة حياة الإصدار وعنوان التعريف واسم المواصفات وملف التعريف لإكمال تسجيل واجهة برمجة التطبيقات.
تتم إضافة واجهة برمجة التطبيقات إلى مخزون مركز API الخاص بك.
تسجيل واجهات برمجة التطبيقات باستخدام مسار CI/CD
تسجل الخطوات التالية واجهة برمجة تطبيقات في مركز API الخاص بك باستخدام مسار CI/CD. باستخدام هذا الخيار، أضف مسار GitHub أو Azure DevOps تم تكوينه مسبقا إلى مساحة عمل Visual Studio Code النشطة التي يتم تشغيلها كجزء من سير عمل CI/CD على كل التزام بالتحكم بالمصادر. يوصى بجرد واجهات برمجة التطبيقات مع مركز واجهة برمجة التطبيقات باستخدام CI/CD لضمان بقاء بيانات تعريف واجهة برمجة التطبيقات بما في ذلك المواصفات والإصدار محدثة في مركز واجهة برمجة التطبيقات الخاص بك مع استمرار تطور واجهة برمجة التطبيقات بمرور الوقت.
- استخدم اختصار لوحة المفاتيح Ctrl+Shift+P لفتح لوحة الأوامر. اكتب Azure API Center: تسجيل واجهة برمجة التطبيقات واضغط على Enter.
- حدد CI/CD.
- حدد إما GitHub أو Azure DevOps، اعتمادا على آلية التحكم بالمصادر المفضلة لديك. يجب أن تكون مساحة عمل Visual Studio Code مفتوحة لملحق Azure API Center لإضافة مسار إلى مساحة العمل الخاصة بك. بعد إضافة الملف، أكمل الخطوات الموثقة في ملف البنية الأساسية لبرنامج ربط العمليات التجارية CI/CD نفسه لتكوين متغيرات البيئة والهوية المطلوبة. عند الدفع إلى التحكم بالمصادر، يتم تسجيل واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات.
لمعرفة المزيد حول إعداد سير عمل GitHub Actions، راجع تسجيل واجهات برمجة التطبيقات في مركز واجهة برمجة التطبيقات باستخدام GitHub Actions.
إنشاء مواصفات OpenAPI من التعليمات البرمجية لواجهة برمجة التطبيقات
استخدم قوة GitHub Copilot مع ملحق Azure API Center ل Visual Studio Code لإنشاء ملف مواصفات OpenAPI من التعليمات البرمجية لواجهة برمجة التطبيقات. انقر بزر الماوس الأيمن فوق التعليمات البرمجية لواجهة برمجة التطبيقات، وحدد Copilot من الخيارات، وحدد Generate API documentation. ينشئ GitHub Copilot ملف مواصفات OpenAPI.
يمكنك أيضا إنشاء مواصفات OpenAPI من جميع الملفات في مشروعك الحالي. استخدم Azure API Center: إنشاء مواصفات OpenAPI من أمر المشروع بأكمله من لوحة الأوامر.
بعد إنشاء ملف مواصفات OpenAPI والتحقق من الدقة، يمكنك تسجيل واجهة برمجة التطبيقات مع مركز واجهة برمجة التطبيقات باستخدام الأمر Azure API Center: تسجيل واجهة برمجة التطبيقات .
تلميح
يمكن لمطوري واجهة برمجة التطبيقات أيضا إنشاء مواصفات OpenAPI جديدة باستخدام مطالبات اللغة الطبيعية مع المكون الإضافي لمركز API ل GitHub Copilot ل Azure. لمعرفة المزيد، راجع تصميم واجهات برمجة التطبيقات وتطويرها.