استيراد تطبيق ويب Azure كواجهة برمجة تطبيقات

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

توضح هذه المقالة كيفية استخدام مدخل Microsoft Azure لاستيراد تطبيق ويب Azure كواجهة برمجة تطبيقات إلى Azure API Management واختبار واجهة برمجة التطبيقات المستوردة.

إشعار

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

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

• استيراد تطبيق ويب، الذي تتم استضافته في Azure App Service، كواجهة برمجة تطبيقات
• حدد التطبيق في مدخل Microsoft Azure

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

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

يوفر استخدام API Management لعرض واجهة برمجة تطبيقات مستضافة على تطبيقات الويب هذه الفوائد:

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

لمزيد من المعلومات، راجع حول APIM .

تعريف OpenAPI مقابل عمليات أحرف البدل

تدعم APIM استيراد تطبيقات الويب المستضافة في App Service التي تتضمن تعريف OpenAPI (تعريف Swagger). ومع ذلك، تعريف OpenAPI غير مطلوب.

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

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

• إذا لم يتم توفير تعريف OpenAPI، تقوم APIM بإنشاء عمليات أحرف البدل لأفعال HTTP الشائعة (GET وPUT وما إلى ذلك). قم بإلحاق مسار أو معلمات مطلوبة بعملية حرف بدل لتمرير طلب واجهة برمجة التطبيقات إلى واجهة API الخلفية.

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

مثال

قد يدعم تطبيق الويب الخلفي الخاص بك عمليتين GET:

• https://<app-service>.azurewebsites.net/customer/{id}
• https://<app-service>.azurewebsites.net/customers

يمكنك استيراد تطبيق الويب إلى خدمة APIM في مسار مثل https://<api>.azureapi.net/store. يعرض الجدول التالي العمليات التي يتم استيرادها إلى APIM، بمواصفات OpenAPI أو بدونها:

نوع	العمليات المستوردة	طلبات نموذج
مواصفات OpenAPI	GET /customer/{id} GET /customers	GET https://<api>.azureapi.net/store/customer/1 GET https://<api>.azureapi.net/store/customers
بدل	GET /*	GET https://<api>.azureapi.net/store/customer/1 GET https://<api>.azureapi.net/store/customers

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

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

• أكمل التشغيل السريع إنشاء مثيل إدارة واجهة برمجة تطبيقات Azure.

• تأكد من وجود خدمة تطبيق في اشتراكك. لمزيد من المعلومات، راجع وثائق خدمة التطبيقات .

  للحصول على معلومات حول إنشاء مثال على واجهة برمجة تطبيقات الويب ونشرها كتطبيق ويب Azure، راجع:

  • البرنامج التعليمي: إنشاء واجهة برمجة تطبيقات ويب باستخدامالأساسية ASP.NET .
  • نشر تطبيق ASP.NET Core إلى Azure باستخدام Visual Studio Code.

استيراد ونشر واجهة برمجة تطبيقات خلفية

تلميح

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

1. انتقل إلى خدمة API Management في مدخل Azure.

2. في القائمة اليسرى، في قسم واجهات برمجة التطبيقات ، حدد واجهات برمجة التطبيقات ، ثم حدد + Add API.

3. حدد لوحة App Service:

   

4. حدد استعراض للاطلاع على قائمة خدمات التطبيقات في اشتراكك.

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

   إذا لم يتم العثور على تعريف OpenAPI، تعرض APIM واجهة برمجة التطبيقات عن طريق إنشاء عمليات أحرف البدل لأفعال HTTP الشائعة.

6. أضف لاحقة عنوان URL لواجهة برمجة التطبيقات . اللاحقة هي اسم يعرف واجهة برمجة التطبيقات في مثيل APIM. يجب أن يكون فريدا في مثيل APIM.

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

   إشعار

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

   في مستويات معينة، يأتي كل مثيل APIM مع اثنين من منتجات العينة الافتراضية:

   • المبدئ
   • مطلق

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

9. حدد إنشاء.

اختبار API الجديد في مدخل Microsoft Azure

يمكنك استدعاء العمليات مباشرة من مدخل Microsoft Azure. يوفر هذا الأسلوب طريقة ملائمة لعرض واختبار عمليات واجهة برمجة التطبيقات. يمكنك أيضا اختبار واجهة برمجة التطبيقات في مدخل المطور أو باستخدام أدوات عميل REST الخاصة بك.

1. تحديد واجهة برمجة التطبيقات التي أنشأتها في الخطوة السابقة.

2. في علامة التبويب اختبار، حدد عملية.

   تعرض الصفحة الحقول لمعلمات الاستعلام وحقول الرؤوس. أحد العناوين هو Ocp-Apim-Subscription-Key. هذا العنوان مخصص لمفتاح الاشتراك للمنتج المقترن بواجهة برمجة التطبيقات. إذا قمت بإنشاء مثيل APIM، فأنت مسؤول بالفعل، لذلك يتم ملء المفتاح تلقائيا.

3. اضغط Send.

   عند نجاح الاختبار، تستجيب الواجهة الخلفية بـ 200 OK وبعض البيانات.

اختبار عملية حرف بدل في المدخل

عند إنشاء عمليات حرف البدل، قد لا يتم تعيين العمليات مباشرة إلى واجهة برمجة التطبيقات الخلفية. على سبيل المثال، تستخدم عملية GET الخاصة بحرف البدل التي يتم استيرادها في APIM المسار / افتراضيًا. ومع ذلك، قد تدعم واجهة برمجة التطبيقات الخلفية عملية GET في المسار /api/todoItems.

لاختبار المسار /api/todoItems:

1. حدد واجهة برمجة التطبيقات التي قمت بإنشائها، ثم حدد عملية.

2. في علامة التبويب اختبار، ضمن معلمات قالب ، قم بتحديث القيمة بجوار اسم حرف البدل (*). على سبيل المثال، أدخل api/todoItems. يتم إلحاق هذه القيمة بالمسار / لعملية حرف البدل.

   

3. حدد إرسال.

إلحاق واجهات برمجة تطبيقات أخرى

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

• مواصفات OpenAPI
• واجهة برمجة تطبيقات SOAP
• واجهة برمجة تطبيقات GraphQL
• تطبيق ويب مستضاف في Azure App Service
• دالات Azure
• تطبيقات Azure Logic
• Azure Service Fabric

إشعار

عند استيراد واجهة برمجة تطبيقات، يتم إلحاق العمليات بواجهة برمجة التطبيقات الحالية.

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

1. انتقل إلى مثيل Azure API Management في مدخل Microsoft Azure:

   

2. حدد واجهات برمجة التطبيقات في صفحة نظرة عامة على أو حدد واجهات برمجة التطبيقات >واجهات برمجة التطبيقات في القائمة على اليسار.

   

3. حدد علامة الحذف (...) بجوار واجهة برمجة التطبيقات التي تريد إلحاق واجهة برمجة تطبيقات أخرى بها.

4. حدد استيراد من القائمة المنسدلة:

   

5. حدّد خدمة لاستيراد واجهة برمجة تطبيقات منها.

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

• قيود استيراد API
• استيراد مواصفة OpenAPI
• استيراد واجهة برمجة تطبيقات SOAP
• استيراد واجهة برمجة تطبيقات SOAP وتحويلها إلى REST
• استيراد واجهة برمجة تطبيقات App Service
• استيراد واجهة برمجة تطبيقات تطبيق حاوية
• استيراد واجهة برمجة تطبيقات WebSocket
• استيراد واجهة برمجة تطبيقات GraphQL
• استيراد مخطط GraphQL وإعداد محللات الحقول
• استيراد واجهة برمجة تطبيقات تطبيق دالة
• استيراد واجهة برمجة تطبيقات تطبيق منطقي
• استيراد خدمة Service Fabric
• استيراد واجهة برمجة تطبيقات Azure الذكاء الاصطناعي Foundry
• استيراد واجهة برمجة تطبيقات Azure OpenAI
• استيراد واجهة برمجة تطبيقات LLM
• استيراد واجهة برمجة تطبيقات OData
• استيراد بيانات التعريف لـ SAP OData
• استيراد واجهة برمجة تطبيقات gRPC
• تحرير واجهة برمجة تطبيقات