مشاركة عبر

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

  • مقالة

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

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

إشعار

يمكنك استخدام ملحق API Management لـ Visual Studio Code لاستيراد واجهات برمجة التطبيقات وإدارتها. اتبع البرنامج التعليمي لملحق API Management للتثبيت وبدء التشغيل.

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

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

كشف تطبيق الويب مع APIM

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

APIM هي البيئة الموصى بها لكشف واجهة برمجة تطبيقات مستضافة على تطبيق الويب، وذلك لعدة أسباب:

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

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

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

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

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

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

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

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

مثال

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

  • https://myappservice.azurewebsites.net/customer/{id}
  • https://myappservice.azurewebsites.net/customers

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

نوع العمليات المستوردة طلبات نموذج
مواصفات OpenAPI GET /customer/{id}

GET /customers		 GET https://contosoapi.azureapi.net/store/customer/1

GET https://contosoapi.azureapi.net/store/customers
بدل GET /* GET https://contosoapi.azureapi.net/store/customer/1

GET https://contosoapi.azureapi.net/store/customers

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

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

الانتقال إلى مثيل إدارة واجهة برمجة التطبيقات لديك

  1. في مدخل Microsoft Azure، ابحث عن خدمات APIM وحددها.

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

  2. في صفحة خدمات إدارة واجهة برمجة التطبيقات، حدد مثيل إدارة واجهة برمجة التطبيقات.

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

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

تلميح

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

  1. انتقل إلى خدمة إدارة API في بوابة Azure وحدد واجهات برمجة التطبيقات من القائمة.

  2. حدد خدمة التطبيقات من القائمة.

    إنشاء من خدمة التطبيق

  3. حدد تصفح لمشاهدة قائمة خدمات التطبيقات في اشتراكك.

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

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

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

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

    إشعار

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

    بشكل افتراضي، كل مثيل إدارة API يأتي مع اثنين من عينة من المنتجات:

    • Starter
    • غير محدود

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

  8. حدد إنشاء. إنشاء واجهة برمجة تطبيقات من خدمة التطبيق

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

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

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

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

  3. حدد عملية.

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

  4. اضغط Send.

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

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

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

/api/TodoItems

يمكنك اختبار المسار /api/TodoItems على النحو التالي.

  1. حدد API الذي قمت بإنشائه، وحدد العملية.

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

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

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

  4. حدد إرسال.

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

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

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

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

إشعار

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

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

    الانتقال إلى مثيل Azure API Mgmt

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

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

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

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

    حدد استيراد

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

    تحديد خدمة

الخطوات التالية

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