إنشاء نهج إدارة واجهة برمجة تطبيقات Azure وفهمها وتصحيحها في تعليمة Visual Studio برمجية

ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات

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

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

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

• تعليمة Visual Studio برمجية .

• أحدث إصدار من إدارة Azure API Extension ل تعليمة Visual Studio برمجية.

• الملحقات التالية مطلوبة للسيناريوهات المحددة:

  • GitHub Copilot ل Azure التوسعة لإنشاء وشرح السياسات
  • إضافة عميل REST لتصحيح الأخطاء في السياسات

• مثيل API Management. إذا كنت بحاجة لإنشاء واحد، انظر إنشاء مثيل إدارة Azure API جديد.

• قم باستيراد API إلى مثيل إدارة واجهة برمجة التطبيقات. انظر استخدم امتداد إدارة واجهة برمجة التطبيقات ل تعليمة Visual Studio برمجية لاستيراد وإدارة واجهات برمجة التطبيقات (APIs.

القيود والمحددات

• يتم دعم تصحيح أخطاء السياسة حاليا فقط في طبقة مطور إدارة واجهة برمجة التطبيقات.

• يستخدم تصحيح الأخطاء في السياسات اشتراك الوصول الكامل المدمج (على مستوى الخدمة)، والذي يحمل اسم العرض اشتراك مدمج في الوصول الشامل. يجب أن تكون مالك خدمة لاستخدام هذا الاشتراك.

إنشاء نهج باستخدام GitHub Copilot ل Azure

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

لإنشاء نهج:

1. افتح ملحق إدارة واجهة برمجة التطبيقات في تعليمة Visual Studio برمجية.

2. حدد مثيل إدارة واجهة برمجة التطبيقات الذي تريد العمل معه.

3. حدد نطاق النهج الذي تريد العمل معه.

   • لإنشاء نهج ينطبق على جميع واجهات برمجة التطبيقات في المثيل، حدد السياسة العامة.
   • لإنشاء نهج ينطبق على واجهة برمجة تطبيقات معينة، ضمن واجهات برمجة التطبيقات، حدد واجهة برمجة التطبيقات، ثم حدد نهج.
   • لإنشاء نهج ينطبق على عملية واجهة برمجة تطبيقات معينة، حدد العملية، ثم حدد النهج.

4. افتح Chat.

5. في نافذة المحادثة، أدخل مطالبة بلغة طبيعية لإنشاء سياسة. أمثلة:

   @azure I want to limit requests to 100 calls per minute
   

   @azure Create a policy that sets the backend URL to https://mybackend.contoso.com and adds a custom header to the request
   

   ينشئ Copilot مسودة سياسة في نافذة Chat. يمكنك تحسين المطالبة إذا كنت تريد أن يقوم Copilot بتغيير الإخراج.

6. عندما تكون جاهزا، حدد الزر نسخ لنسخ النهج إلى الحافظة، أو حدد تطبيق في المحرر لإدراج النهج في نافذة المحرر. إذا كنت راضيا عن التغيير في سياسة XML، اختر الاحتفاظ به.

تلميح

تحقق من نافذة المشاكل للحصول على شرح لأي مشكلات في XML للنهج.

شرح نهج باستخدام GitHub Copilot ل Azure

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

لتلقي شرح:

1. افتح ملحق إدارة واجهة برمجة التطبيقات في تعليمة Visual Studio برمجية.

2. حدد مثيل إدارة واجهة برمجة التطبيقات الذي تريد العمل معه.

3. حدد نطاق النهج الذي تريد العمل معه.

   • لشرح نهج ينطبق على جميع واجهات برمجة التطبيقات في المثيل، حدد السياسة العامة.
   • لشرح نهج ينطبق على واجهة برمجة تطبيقات معينة، ضمن واجهات برمجة التطبيقات، حدد واجهة برمجة التطبيقات، ثم حدد النهج.
   • لشرح نهج ينطبق على عملية واجهة برمجة تطبيقات معينة، حدد العملية، ثم حدد النهج.

4. في نافذة محرر السياسات التي تظهر، انقر بزر الفأرة الأيمن، ثم اختر شرح.

5. يتم إنشاء نظرة عامة وشرح للنهج في مستند XML للسياسة في نافذة الدردشة.

نهج تصحيح الأخطاء باستخدام ملحق VS Code

يوفر ملحق إدارة Azure API ل تعليمة Visual Studio برمجية تجربة تصحيح الأخطاء التي تسمح لك بالمرور عبر مسار النهج أو تعيين نقطة توقف عند إرسال طلب إلى البوابة.

بدء جلسة عمل تصحيح الأخطاء

1. افتح ملحق إدارة واجهة برمجة التطبيقات في تعليمة Visual Studio برمجية.
2. حدد مثيل إدارة واجهة برمجة التطبيقات لتصحيح الأخطاء.
3. حدد واجهة برمجة التطبيقات والعملية لتصحيح الأخطاء.
4. انقر بزر الفأرة الأيمن على العملية واختر بدء تصحيح السياسات.

يبدأ الامتداد في إنشاء جلسة تصحيح الأخطاء باستخدام بوابة إدارة واجهة برمجة التطبيقات. تحقق من التقدم في نافذة وحدة تحكم تصحيح الأخطاء .

إشعار

بدء جلسة تصحيح الأخطاء يتيح أيضا تتبع الطلبات أثناء الجلسة، لمساعدتك في تشخيص وحل المشكلات.

إرسال طلب اختبار

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

تتم إضافة رأس Ocp-Apim-Debug تلقائيا إلى الطلب. هذا العنوان مطلوب ويجب تعيين القيمة إلى مفتاح الاشتراك على مستوى الخدمة، كافة الوصول لتشغيل وظيفة تصحيح الأخطاء في بوابة API Management.

تعديل طلب HTTP في المحرر وفقًا لسيناريو الاختبار الخاص بك. ثم اختر إرسال طلب لإرسال طلب الاختبار إلى بوابة إدارة واجهة برمجة التطبيقات.

تصحيح النهج

بعد إرسال طلب HTTP التجريبي، يفتح الملحق نافذة تصحيح الأخطاء، والتي تعرض السياسات الفعالة لهذه العملية وتتوقف عند أول نهج فعال.

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

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

إذا حدث خطأ أثناء تنفيذ السياسة، سترى تفاصيل الخطأ في السياسة التي حدث فيها ذلك.

للخروج من جلسة التصحيح، اختر توقف.

تلميح

لمراجعة تتبع الطلب، حدد قيمة الرأس Ocp-Apim-Trace-Location الذي تم توفيره في استجابة HTTP.

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

• تعرف أكثر على امتداد إدارة API ل تعليمة Visual Studio برمجية
• الإبلاغ عن مشكلات في مستودع GitHub