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

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

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

إشعار

حاليا، هذه الميزة غير متوفرة في مساحات العمل.

في هذه المقالة، ستتعرف على كيفية:

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

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

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

• فهم مصطلحات Azure API Management.
• تثبيت كود Visual Studio وأحدث إضافة لإدارة واجهة برمجة التطبيقات Azure لكود Visual Studio.
• أنشئ نسخة إدارة واجهة برمجة تطبيقات (API).

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

يوضح المثال التالي استيراد مواصفات OpenAPI بتنسيق JSON إلى إدارة واجهة برمجة التطبيقات. على سبيل المثال، يمكنك استيراد مصدر مفتوح Petstore API.

1. في Visual Studio Code، حدد رمز Azure من شريط النشاط.

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

3. اخترواجهات برمجة التطبيقات، وحدد استيراد من رابط OpenAPI.

4. عند المطالبة، أدخل القيم التالية:

   1. رابط OpenAPI للمحتوى بتنسيق JSON. لهذا المثال: https://petstore.swagger.io/v2/swagger.json.

      يحدد هذا الملف خدمة الواجهة الخلفية التي تنفذ مثال واجهة برمجة التطبيقات والعمليات التي تدعمها.

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

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

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

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

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

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

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

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

1. في جزء Explorer، حدد Policy ضمن petstore API التي قمت باستيرادها. فتح ملف النهج في إطار المحرر. يقوم هذا الملف بتكوين نهج لجميع العمليات في واجهة برمجة التطبيقات.

2. تحديث الملف بالمحتوى التالي:

   <policies>
       <inbound>
           <rate-limit calls="3" renewal-period="15" />
           <base />
       </inbound>
       <outbound>
           <set-header name="Custom" exists-action="override">
               <value>"My custom value"</value>
             </set-header>
           <base />
       </outbound>
       <on-error>
           <base />
       </on-error>
   </policies>
   

   • rate-limit السياسة في القسم inbound تحد من عدد المكالمات إلى واجهة برمجة التطبيقات إلى 3 مكالمات كل 15 ثانية.
   • set-header يضيف النهج في outbound القسم عنوان استجابة مخصص لأغراض العرض التوضيحي.

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

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

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

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

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

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

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

   

   تنبيه

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

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

1. في جزء Explorer، قم بتوسيع عقدة Operations ضمن petstore API التي قمت باستيرادها.

2. حدد عملية مثل [GET] Find pet by ID، ثم انقر بزر الماوس الأيمن فوق العملية وحدد Test Operation.

3. في نافذة المحرر، استبدل 5 المعلمة petId في عنوان URL للطلب.

4. في نافذة المحرر، بجوار Ocp-Apim-Subscription-Key، الصق مفتاح الاشتراك الذي نسخته.

5. حدد إرسال طلب.

   

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

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

• Custom تتم إضافة العنوان إلى الاستجابة.

الآن اختبر نهج تحديد المعدل. حدد إرسال الطلب عدة مرات متتالية. بعد إرسال عدد كبير جدا من الطلبات في الفترة التي تم تكوينها، تحصل على الاستجابة 429 Too Many Requests .

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

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

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

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

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

بدلا من ذلك، يمكنك تحديد Delete API Management لحذف مثيل APIM فقط. هذه العملية لا تحذف مجموعة الموارد الخاصة بها.

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

توفر إضافة إدارة واجهات برمجة التطبيقات ميزات إضافية للعمل مع واجهات برمجة التطبيقات الخاصة بك، مثل:

• إنشاء وفهم وتصحيح سياسات إدارة واجهة برمجة تطبيقات Azure (المتوفرة في مستوى خدمة المطورين)
• استخدم القيم المسماة في سياسات إدارة واجهة برمجة تطبيقات Azure