البرنامج التعليمي: استخدام ملحق Azure API Management ل Visual Studio Code لاستيراد واجهات برمجة التطبيقات وإدارتها

ينطبق على: الاستهلاك | المطور | أساسي | قياسي | بريميوم

في هذا البرنامج التعليمي، ستتعلم كيفية استخدام ملحق APIM ل Visual Studio Code للعمليات الشائعة في APIM. استخدم بيئة التعليمات البرمجية Visual Studio المألوفة لاستيراد واجهات برمجة التطبيقات، تحديثها، اختبارها وإدارتها.

‏‫ستتعلم كيفية:

• استيراد API إلى API Management
• تحرير واجهة برمجة التطبيقات
• تطبيق معايير إدارة واجهة برمجة التطبيقات
• اختبار واجهة برمجة التطبيقات

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

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

• فهم مصطلحات Azure API Management.
• تأكد من تثبيت Visual Studio Code وأحدث ملحق Azure API Management ل Visual Studio Code.
• إنشاء مثيل API Management.

استيراد واجهة API

يوضح المثال التالي استيراد مواصفات OpenAPI بتنسيق JSON إلى إدارة واجهة برمجة التطبيقات. توفر Microsoft واجهة برمجة التطبيقات الخلفية المستخدمة في هذا المثال، وتستضيفها على Azure في https://conferenceapi.azurewebsites.net.

1. في Visual Studio Code، حدد رمز Azure من شريط النشاط.
2. في الجزء الظاهر، قم بتوسيع نموذج إدارة واجهة برمجة التطبيقات الذي قمت بإنشائه.
3. اخترواجهات برمجة التطبيقات، وحدد استيراد من رابط OpenAPI.
4. عند المطالبة، أدخل القيم التالية:

   1. رابط OpenAPI للمحتوى بتنسيق JSON. لهذا المثال: https://conferenceapi.azurewebsites.net?format=json.

      يحدد هذا الملف خدمة الواجهة الخلفية التي تنفذ مثال API، في هذه الحالة https://conferenceapi.azurewebsites.net. API Management بإعادة توجيه الطلبات إلى خدمة الويب هذه.

   2. اسم API، مثل demo-conference-api، فريد في نموذج إدارة واجهة برمجة التطبيقات. يمكن أن يحتوي هذا الاسم على أحرف وأرقام وواصلات فقط. يجب أن تكون الأحرف الأولى والأخيرة أبجدية رقمية. يتم استخدام هذا الاسم في المسار لاستجابة واجهة برمجة التطبيقات.

بعد استيراد واجهة برمجة التطبيقات بنجاح، يظهر في جزء مستكشف، وتظهر عمليات واجهة برمجة التطبيقات المتوفرة تحت عقدة العمليات.

تحرير واجهة برمجة التطبيقات

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

لتحرير تنسيق OpenAPI، اختر اسم واجهة برمجة التطبيقات في جزء المستكشف وحدد تحرير OpenAPI. قم بإجراء التغييرات، ثم حدد حفظ >الملف.

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

توفر إدارة واجهة برمجة التطبيقات نُهُج يمكنك من خلالها تكوين واجهات برمجة التطبيقات الخاصة بك. النهج هي مجموعة من العبارات. يتم تشغيل هذه البيانات بالتسلسل بناءً على طلب أو استجابة API. يمكن أن تكون المعايير عمومية، والتي تنطبق على جميع واجهات برمجة التطبيقات في مثيل إدارة API الخاص بك، أو يمكن تخصيصها إلى API أو عملية API معينة.

يوضح هذا القسم كيفية تطبيق النهج الصادرة الشائعة على واجهة برمجة التطبيقات التي تحول استجابة API. السياسات في هذا المثال تغيير رؤوس الاستجابة وإخفاء عناوين URL الخلفية الأصلية التي تظهر في نص الاستجابة.

1. في جزء مستكشف، حدد النهج ضمن demo-conference-api المستردة. فتح ملف النهج في إطار المحرر. يقوم هذا الملف بتكوين نهج لجميع العمليات في واجهة برمجة التطبيقات.

2. تحديث الملف مع المحتوى التالي في <outbound> العنصر:

   [...]
   <outbound>
       <set-header name="Custom" exists-action="override">
           <value>"My custom value"</value>
       </set-header>
       <set-header name="X-Powered-By" exists-action="delete" />
       <redirect-content-urls />
       <base />
   </outbound>
   [...]
   

   • يضيف النهج الأول set-header رأس استجابة مخصصاً لأغراض العرض التوضيحي.
   • النهج الثاني set-header حذف رأس X-Powered-By، إذا كان موجوداً. يمكن أن يكشف هذا الرأس ويزيل إطار عمل التطبيق المستخدم في واجهة برمجة التطبيقات الخلفية والناشرين غالباً.
   • redirect-content-urlsإعادة كتابة معايير (masks) الارتباطات في نص الاستجابة بحيث تشير إلى الارتباطات المكافئة عبر عبارة إدارة واجهة برمجة التطبيقات.

3. حفظ الملف. إذا تمت مطالبتك، فحدد Upload لتحميل الملف إلى السحابة.

اختبار واجهة برمجة التطبيقات

لاختبار واجهة برمجة التطبيقات، احصل على مفتاح اشتراك ثم قم بإجراء طلب إلى بوابة APIM.

الحصول على مفتاح الاشتراك

تحتاج إلى مفتاح اشتراك لمثيل إدارة واجهة برمجة تطبيقاتك لاختبار واجهة برمجة التطبيقات المستوردة التي قمت باستيرادها والسياسات التي يتم تطبيقها.

1. في جزء مستكشف، اختر اسم نموذج إدارة واجهة برمجة تطبيقاتك.

2. حدد نسخ مفتاح الاشتراك. هذا المفتاح مخصص لجميع اشتراكات الوصول المضمنة التي يتم إنشاؤها عند إنشاء مثيل APIM.

   

   تنبيه

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

اختبار عملية API

1. في جزء المستكشف، قم بتوسيع عقدة العمليات ضمن demo-Conference-api الذي قمت باستيراده.
2. حدد عملية مثل GetSpeakers، ثم انقر بزر الماوس الأيمن فوق العملية وحدد اختبار العملية.
3. في نافذة المحرر، بجانب Ocp-Apim-Subscription-Key، استبدل {{SubscriptionKey}} مفتاح الاشتراك الذي قمت بنسخه.
4. حدد إرسال طلب.

عندما ينجح الطلب، تستجيب الخلفية مع 200 موافق وبعض البيانات.

لاحظ التفاصيل التالية في الاستجابة:

• تتم إضافة رأس مخصص إلى الاستجابة.
• لا يظهر رأس X-Powered-By في الاستجابة.
• تتم إعادة توجيه عناوين URL إلى واجهة برمجة التطبيقات الخلفية إلى مسار إدارة واجهة برمجة التطبيقات، في هذه الحالةhttps://apim-hello-world.azure-api.net/demo-conference-api.

تتبع معالجة الطلب

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

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

تنظيف الموارد

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

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

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

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

• استيراد API إلى API Management
• تحرير واجهة برمجة التطبيقات
• تطبيق معايير إدارة واجهة برمجة التطبيقات
• اختبار واجهة برمجة التطبيقات

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