تمكين عرض مدخل Azure API Center وعرضه - ملحق VS Code

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

تلميح

يوفر ملحق Visual Studio Code المزيد من الميزات لمطوري واجهة برمجة التطبيقات الذين لديهم أذونات لإدارة مركز Azure API. على سبيل المثال، يمكن لمطوري واجهة برمجة التطبيقات تسجيل واجهات برمجة التطبيقات في مركز واجهة برمجة التطبيقات مباشرة أو باستخدام مسارات CI/CD. معرفة المزيد

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

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

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

• أذونات لإنشاء تسجيل تطبيق في مستأجر Microsoft Entra المقترن باشتراك Azure الخاص بك، وأذونات لمنح حق الوصول إلى البيانات في مركز API الخاص بك.

لمطوري التطبيقات

• ملحق Azure API Center ل Visual Studio Code

ملحقات Visual Studio Code التالية اختيارية:

• ملحق Microsoft Kiota - لإنشاء عملاء واجهة برمجة التطبيقات
• GitHub Copilot وGitHub Copilot Chat، المتوفرين مع الوصول إلى GitHub Copilot - لاستخدام أدوات نموذج اللغة في وضع العامل لاكتشاف واجهات برمجة التطبيقات

خطوات لمسؤولي مركز واجهة برمجة التطبيقات لتمكين الوصول إلى طريقة عرض مدخل مركز واجهة برمجة التطبيقات

توفر الأقسام التالية خطوات لمسؤولي مركز واجهة برمجة التطبيقات لتمكين مطوري المؤسسات من الوصول إلى طريقة عرض مدخل مركز واجهة برمجة التطبيقات.

إنشاء تسجيل تطبيق Microsoft Entra

قم أولا بتكوين تسجيل تطبيق في مستأجر معرف Microsoft Entra. يتيح تسجيل التطبيق لمدخل API Center الوصول إلى البيانات من مركز واجهة برمجة التطبيقات نيابة عن مستخدم مسجل الدخول.

يمكن ل API Center إعداد تسجيل التطبيق تلقائيا، أو يمكنك إنشاء تسجيل التطبيق يدويا.

إعداد تسجيل التطبيق تلقائيا

لإعداد تسجيل التطبيق تلقائيا، اتبع الخطوات التالية:

1. في مدخل Microsoft Azure، انتقل إلى مركز واجهة برمجة التطبيقات.
2. في القائمة اليسرى، حدد API Center portal>Settings.
3. في علامة التبويب موفر الهوية ، حدد بدء الإعداد.
4. في علامة التبويب الإعداد السريع ، حدد حفظ + نشر.

إذا كنت بحاجة إلى الوصول إلى تسجيل التطبيق لاحقا، فيمكنك العثور عليه في المدخل ضمن تسجيلات التطبيقات. يتم تسمية التطبيق بالتنسيق التالي: <api-center-name-apic-aad>.

إعداد تسجيل التطبيق يدويا

إذا كنت تريد إنشاء تسجيل التطبيق يدويا، فاتبع الخطوات التالية:

1. في مدخل Microsoft Azure، انتقل إلى معرف Microsoft Entra>إدارة>تسجيلات التطبيقات.

2. حدد + New registration.

3. في صفحة Register an application،قم بتعيين القيم كما يلي:

   1. تعيين Name إلى اسم ذي معنى مثل api-center-portal
   2. ضمن أنواع الحسابات المدعومة، حدد الحسابات في هذا الدليل التنظيمي فقط (<اسم> الدليل - مستأجر واحد).
   3. في Redirect URI، حدد Single-page application (SPA) وقم بتعيين URI. أدخل URI الخاص بنشر مدخل API Center، في النموذج التالي: https://<service-name>.portal.<location>.azure-apicenter.ms. استبدل <service name> و <location> باسم مركز واجهة برمجة التطبيقات والموقع الذي تم نشره فيه، مثال: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. حدد تسجيل.

تكوين معرفات URI لإعادة التوجيه الإضافية لملحق VS Code

عند تمكين طريقة عرض مدخل API Center في ملحق Visual Studio Code لمركز واجهة برمجة التطبيقات، قم أيضا بتكوين عناوين URL لإعادة التوجيه التالية في تسجيل التطبيق:

1. في مدخل Microsoft Azure، انتقل إلى تسجيل التطبيق الخاص بك.

2. في صفحة إدارة>المصادقة ، حدد إضافة نظام أساسي وحدد تطبيقات الجوال وسطح المكتب.

3. تكوين عناوين URI الثلاثة المخصصة التالية لإعادة التوجيه:
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   استبدل <application-client-id> بمعرف التطبيق (العميل) لهذا التطبيق. يمكنك العثور على هذه القيمة في صفحة نظرة عامة لتسجيل التطبيق.

تمكين تسجيل الدخول إلى طريقة عرض مدخل API Center بواسطة مستخدمي Microsoft Entra ومجموعاته

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

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

مهم

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

للحصول على المتطلبات الأساسية التفصيلية والخطوات لتعيين دور للمستخدمين والمجموعات، راجع تعيين أدوار Azure باستخدام مدخل Microsoft Azure. الخطوات الموجزة التالية:

1. في مدخل Microsoft Azure، انتقل إلى مركز واجهة برمجة التطبيقات.
2. في القائمة اليسرى، حدد Access control (IAM)>+ Add role assignment.
3. في جزء Add role assignment ، قم بتعيين القيم كما يلي:
   1. في صفحة الدور ، ابحث عن قارئ بيانات Azure API Center وحدده. حدد التالي.
   2. في صفحة الأعضاء، في تعيين الوصول إلى، حدد المستخدم أو المجموعة أو كيان> الخدمة+ حدد الأعضاء.
   3. في صفحة تحديد الأعضاء ، ابحث عن المستخدمين أو المجموعات التي تريد تعيين الدور إليها وحددها. انقر فوق تحديد ثم التالي.
   4. راجع تعيين الدور، وحدد Review + assign.

‏‫ملاحظة

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

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

‏‫ملاحظة

تتم مطالبة المستخدم الأول الذي سجل الدخول إلى المدخل بالموافقة على الأذونات المطلوبة من قبل تسجيل تطبيق مدخل API Center. بعد ذلك، لا تتم مطالبة المستخدمين الآخرين المكونين بالموافقة.

خطوات لمطوري المؤسسات للوصول إلى طريقة عرض مدخل مركز واجهة برمجة التطبيقات

يمكن للمطورين اتباع هذه الخطوات للاتصال وتسجيل الدخول إلى طريقة عرض مدخل مركز واجهة برمجة التطبيقات باستخدام ملحق Visual Studio Code. يجب توفير الإعدادات للاتصال بمركز واجهة برمجة التطبيقات من قبل مسؤول مركز واجهة برمجة التطبيقات. بعد الاتصال، يمكن للمطورين اكتشاف واجهات برمجة التطبيقات واستهلاكها في مركز واجهة برمجة التطبيقات.

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

1. في Visual Studio Code، في شريط النشاط على اليسار، حدد API Center.

   

2. استخدم اختصار لوحة المفاتيح Ctrl+Shift+P لفتح لوحة الأوامر. اكتب Azure API Center: اتصل بمركز واجهة برمجة التطبيقات واضغط على Enter.

3. أجب على المطالبات لإدخال المعلومات التالية:

   1. عنوان URL لوقت التشغيل لمركز واجهة برمجة التطبيقات الخاص بك، بالتنسيق <service name>.data.<region>.azure-apicenter.ms (لا تقم بالبادئة مع https://). مثال: contoso-apic.data.eastus.azure-apicenter.ms. يظهر عنوان URL لوقت التشغيل هذا في صفحة نظرة عامة لمركز واجهة برمجة التطبيقات في طريقة عرض مدخل Microsoft Azure.

   2. معرف التطبيق (العميل) من تسجيل التطبيق الذي قام المسؤول بتكوينه في القسم السابق.

   3. معرف الدليل (المستأجر) من تسجيل التطبيق الذي قام المسؤول بتكوينه في القسم السابق.

   تلميح

   يحتاج مسؤول مركز API إلى توفير تفاصيل الاتصال السابقة للمطورين، أو توفير ارتباط مباشر بالتنسيق التالي:
   vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

   بعد الاتصال بمركز واجهة برمجة التطبيقات، يظهر اسم مركز واجهة برمجة التطبيقات في طريقة عرض مدخل مركز واجهة برمجة التطبيقات.

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

   

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

   

6. كرر الخطوات السابقة للاتصال بمزيد من مراكز واجهة برمجة التطبيقات، إذا تم تكوين الوصول.

اكتشاف واجهات برمجة التطبيقات واستهلاكها في طريقة عرض مدخل مركز واجهة برمجة التطبيقات

تساعد طريقة عرض مدخل API Center مطوري المؤسسات على اكتشاف تفاصيل واجهة برمجة التطبيقات وبدء تطوير عميل واجهة برمجة التطبيقات. يمكن للمطورين الوصول إلى الميزات التالية بالنقر بزر الماوس الأيمن فوق تعريف واجهة برمجة التطبيقات في طريقة عرض مدخل مركز واجهة برمجة التطبيقات:

• تصدير مستند مواصفات واجهة برمجة التطبيقات - تصدير مواصفات واجهة برمجة التطبيقات من تعريف ثم تنزيله كملف
• إنشاء عميل واجهة برمجة التطبيقات - استخدم ملحق Microsoft Kiota لإنشاء عميل واجهة برمجة التطبيقات للغاته المفضلة
• إنشاء Markdown - إنشاء وثائق واجهة برمجة التطبيقات بتنسيق Markdown
• وثائق OpenAPI - عرض الوثائق الخاصة بتعريف واجهة برمجة التطبيقات وتجربة العمليات في واجهة مستخدم Swagger (متوفرة فقط لتعريفات OpenAPI)

استخدام أدوات نموذج اللغة

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

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

لإضافة أدوات وضع لغة مركز واجهة برمجة التطبيقات واستخدامها في وضع وكيل GitHub Copilot:

1. الاتصال بمركز API كما هو موضح في قسم سابق.

2. افتح GitHub Copilot Chat في Visual Studio Code.

3. تعيين وضع GitHub Copilot Chat إلى Agent.

4. حدد الأيقونة أدوات في نافذة الدردشة.

   

5. حدد واحدة أو أكثر من أدوات مركز واجهة برمجة التطبيقات لتكون متوفرة في الدردشة.

   

6. أدخل مطالبة في نافذة الدردشة لاستخدام الأدوات المتوفرة. على سبيل المثال:

   Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
   

7. راجع الردود من GitHub Copilot Chat. تابع المحادثة لتحسين النتائج أو طرح أسئلة المتابعة.

استكشاف الأخطاء وإصلاحها

تعذر تسجيل الدخول إلى Azure

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

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

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

• إنشاء وتسجيل واجهات برمجة التطبيقات مع ملحق Azure API Center ل Visual Studio Code

• أفضل ممارسات التحكم في الوصول استناداً إلى الدور في Azure

• تسجيل موفر موارد