تصميم واجهات برمجة التطبيقات وتطويرها باستخدام المكون الإضافي ل API Center ل GitHub Copilot ل Azure

يعمل المكون الإضافي API Center ل GitHub Copilot for Azure على تسريع تصميم وتطوير واجهات برمجة التطبيقات الجديدة بدءا من مطالبات اللغة الطبيعية. المساعدة في الذكاء الاصطناعي متاحة لك من خلال إضافة API Center مع إضافة API Center الخاصة ب تعليمة Visual Studio برمجية. فقط صف لك واجهة برمجة التطبيقات وقم بسرعة بإنشاء مواصفة OpenAPI لتطوير واجهات برمجة التطبيقات تتوافق مع معايير مؤسستك. بعد إنشاء مواصفات متوافقة، يمكنك تسجيل واجهة برمجة التطبيقات مع مركز API الخاص بك.

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

إعداد الملحق

قم بإعداد الامتداد باتباع هذه الخطوات:

  1. تثبيت ملحق Azure API Center ل تعليمة Visual Studio برمجية من تعليمة Visual Studio برمجية Marketplace. تثبيت ملحقات أخرى حسب الحاجة.

    إشعار

    تشير الملاحظة [PREVIEW] إلى الميزات المتوفرة فقط في النسخة المسبقة من امتداد Azure API Center. عند تثبيت الإضافة من سوق كود Visual Studio، يمكنك اختيار تثبيت نسخة الإصدار أو نسخة ما قبل الإصدار (حسب توفرها). للتبديل بين الإصدارات المثبتة، اختر زر الإدارة (أيقونة التروس) في عرض الإضافات في كود فيجوال ستوديو.

  2. في كود Visual Studio، في شريط النشاط، اختر API Center:

    لقطة شاشة لأيقونة امتداد API Center في شريط نشاط كود Visual Studio.

  3. إذا لم تكن مسجلا الدخول إلى حساب Azure الخاص بك، اختر تسجيل الدخول إلى Azure، واتبع التعليمات لتسجيل الدخول.

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

قدم طلبا للوكيل @azure

اتبع هذه الخطوات لإنشاء مواصفات OpenAPI باستخدام مطالبات اللغة الطبيعية مع GitHub Copilot ل Azure:

  1. إذا رغبت في ذلك، قم بتعيين دليل نمط API نشط في ملحق Azure API Center. استخدم اختصار لوحة المفاتيح Ctrl+Shift+P لفتح لوحة الأوامر. اكتب Azure API Center: تعيين دليل أنماط واجهة برمجة التطبيقات، وإجراء تحديد، والضغط على Enter.

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

  2. في لوحة الدردشة، قدم طلبا باللغة الطبيعية إلى @azure العامل لوصف ما تفعله واجهة برمجة التطبيقات. مثال:

    @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.

    يتم تشغيل Copilot بواسطة الذكاء الاصطناعي، لذلك من الممكن حدوث مفاجآت وأخطاء. لمزيد من المعلومات، راجع الأسئلة المتداولة حول Copilot.

    يستجيب العامل بمستند مواصفات OpenAPI.

    لقطة شاشة توضح كيفية استخدام @azure الإضافة لإنشاء مواصفات OpenAPI من خلال الطلب.

  3. راجع الإخراج الذي تم إنشاؤه للتأكد من الدقة والاكتمال والتوافق مع دليل نمط واجهة برمجة التطبيقات.

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

    تلميح

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

  4. عندما يلبي متطلباتك، احفظ مواصفات OpenAPI التي تم إنشاؤها في ملف.

تسجيل واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات

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

  1. في تعليمة Visual Studio برمجية، اختر زر تسجيل واجهة برمجة التطبيقات في API Center في لوحة الدردشة، أو اختر Azure API Center: تسجيل API من لوحة الأوامر.

  2. حدد Manual.

  3. اختر مركز واجهة برمجة التطبيقات الذي تريد تسجيل واجهات برمجة التطبيقات معه.

  4. الرد على المطالبات بمعلومات بما في ذلك عنوان واجهة برمجة التطبيقات والنوع وعنوان الإصدار ودورة حياة الإصدار وعنوان التعريف واسم المواصفات وملف التعريف (المواصفات) لإكمال تسجيل واجهة برمجة التطبيقات.

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

  1. قم بتوسيع طريقة عرض شجرة مركز واجهة برمجة التطبيقات لتحديد تعريف إصدار واجهة برمجة التطبيقات الذي قمت بتسجيله.

  2. انقر بزر الماوس الأيمن فوق التعريف، وحدد Open API Documentation. تظهر علامة تبويب جديدة مع واجهة مستخدم Swagger لتعريف واجهة برمجة التطبيقات.

لقطة شاشة لواجهة Swagger في امتداد مركز واجهة برمجة التطبيقات Azure ل تعليمة Visual Studio برمجية.

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

  • Last updated on