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

2025-03-31

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

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

إشعار

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

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

استيراد تطبيق حاوية يعرض واجهة برمجة تطبيقات الويب
حدد التطبيق في مدخل Microsoft Azure

كشف تطبيق حاوية باستخدام APIM

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

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

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

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

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

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

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

تكوين تطبيق الحاوية
/openapi.json
/openapi.yml
/swagger/v1/swagger.json

إذا لم يتم توفير مواصفات OpenAPI، تنشئ APIM عمليات أحرف البدل لأفعال HTTP الشائعة (GET وPUT وما إلى ذلك). لا يزال بإمكانك الاستفادة من نفس ميزات APIM، ولكن لا يتم تحديد العمليات على نفس مستوى التفاصيل.

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

مثال

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

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

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

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

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

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

أكمل التشغيل السريعلمثيل Azure APIM.
تأكد من وجود تطبيق حاوية يعرض واجهة برمجة تطبيقات الويب في اشتراكك. لمزيد من المعلومات، راجع وثائق تطبيقات الحاوية.

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

انتقل إلى خدمة APIM في مدخل Microsoft Azure وحددواجهات برمجة التطبيقات APIs> في الجزء الأيمن.
ضمن Create from Azure resource، حدد Container App:
حدد استعراض للاطلاع على قائمة بتطبيقات الحاويات في اشتراكك.
حدد تطبيق حاوية. إذا كان تعريف OpenAPI مقترنا بتطبيق الحاوية المحدد، فإن APIM تجلبه وتستورده. إذا لم يتم العثور على تعريف OpenAPI، تعرض APIM واجهة برمجة التطبيقات عن طريق إنشاء عمليات أحرف البدل لأفعال HTTP الشائعة.
أضف لاحقة عنوان URL لواجهة برمجة التطبيقات . اللاحقة هي اسم يعرف واجهة برمجة التطبيقات في مثيل APIM. يجب أن يكون فريدا في مثيل APIM.
إقران واجهة برمجة التطبيقات بمنتج. حدد كامل ثم في المنتج، حدد المنتج. في هذه الحالة، يتم استخدام المنتج غير المحدود . إذا كنت تريد نشر واجهة برمجة التطبيقات وإتاحتها للمطورين، فستحتاج إلى إضافتها إلى منتج.
إشعار

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

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

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

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

لاختبار واجهة برمجة التطبيقات في مدخل Microsoft Azure:

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

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

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

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

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

/api/TodoItems

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

حدد واجهة برمجة التطبيقات التي قمت بإنشائها، ثم حدد العملية.
حدد علامة التبويب الاختبار.
في معلمات النموذج ، قم بتحديث القيمة بجوار اسم حرف البدل (*). على سبيل المثال، قم بإدخال api/TodoItems. يتم إلحاق هذه القيمة بالمسار / لعملية حرف البدل.
حدد إرسال.

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

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

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

إشعار

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

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

انتقل إلى مثيل Azure API Management في مدخل Microsoft Azure:
حدد واجهات برمجة التطبيقات في صفحة نظرة عامة على أو حدد واجهات برمجة التطبيقات >واجهات برمجة التطبيقات في القائمة على اليسار.
حدد علامة الحذف (...) بجوار واجهة برمجة التطبيقات التي تريد إلحاق واجهة برمجة تطبيقات أخرى بها.
حدد استيراد من القائمة المنسدلة:
حدّد خدمة لاستيراد واجهة برمجة تطبيقات منها.