مشاركة عبر

إضافة واجهة برمجة تطبيقات يدوياً

  • مقالة

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

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

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

في هذه المقالة، ننشئ API فارغة ونحدد httpbin.org (خدمة اختبار عامة) كـ API خلفية.

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

إتمام التشغيل السريع التالي: إنشاء مثيل في Azure APIM

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

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

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

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

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

إنشاء واجهة برمجة تطبيقات

  1. انتقل إلى خدمة إدارة API في بوابة Azure وحدد واجهات برمجة التطبيقات من القائمة.
  2. من القائمة اليمنى، حدد + إضافة API.
  3. حدد HTTP من القائمة.
    API فارغة
  4. أدخل عنوان URL لخدمة الويب للواجهة الخلفية (على سبيل المثال، https://httpbin.org) والإعدادات الأخرى لـ API. يتم شرح الإعدادات في استيراد ونشر البرنامج التعليمي الأول لواجهة برمجة التطبيقات.
  5. حدد إنشاء.

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

إشعار

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

إضافة عملية واختبارها

يوضح هذا القسم كيفية إضافة عملية "/ get" لتعيينها إلى النهاية الخلفية "http://httpbin.org/get"؛ العملية.

إضافة عملية

  1. تحديد واجهة برمجة التطبيقات التي أنشأتها في الخطوة السابقة.
  2. تحديد + Add Operation.
  3. في URL، حدد GET وأدخل /get في المورد.
  4. أدخل "FetchData" لاسم العرض.
  5. حدد حفظ.

اختبار عملية

اختبر العملية في بوابة Azure. يمكنك أيضاً اختباره في Developer portal.

  1. حدد علامة التبويب الاختبار.
  2. حدد FetchData.
  3. اضغط Send.

يظهر الرد الذي تولده العملية "http://httpbin.org/get". إذا كنت ترغب في تحويل عملياتك، راجع تحويل واجهة برمجة التطبيقات وحمايتها.

إضافة واختبار عملية ذات معلمات

يوضح هذا القسم كيفية إضافة عملية تأخذ معلمة. في هذه الحالة، نربط العملية بـ "http://httpbin.org/status/200"؛.

إضافة عملية

  1. تحديد واجهة برمجة التطبيقات التي أنشأتها في الخطوة السابقة.
  2. تحديد + Add Operation.
  3. في URL، حدد GET وأدخل /status/{code} في المورد. بشكل اختياري، يمكنك توفير بعض المعلومات المقترنة بهذه المعلمة. على سبيل المثال، أدخل"رقم"لـTYPE،"200" (افتراضي) للقيم.
  4. أدخل "GetStatus" من أجل Display name.
  5. حدد حفظ.

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

اختبر العملية في بوابة Azure. يمكنك أيضاً اختباره في Developer portal.

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

  2. حدد GetStatus. تُعيّن هذه القيمة افتراضياً على "200". يمكنك تغييره لاختبار قيم أخرى. على سبيل المثال، كتابة "418".

  3. اضغط Send.

    يظهر الرد الذي تولده العملية "http://httpbin.org/status/200". إذا كنت ترغب في تحويل عملياتك، راجع تحويل واجهة برمجة التطبيقات وحمايتها.

إضافة واختبار عملية wildcard

يوضح هذا القسم كيفية إضافة عملية wildcard. تتيح لك عملية wildcard تمرير قيمة إجبارية مع طلب API. بدلا من إنشاء عمليات GET منفصلة كما هو موضح في الأجزاء السابقة، يمكنك إنشاء عملية GET البدل.

تنبيه

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

إضافة عملية

  1. تحديد واجهة برمجة التطبيقات التي أنشأتها في الخطوة السابقة.
  2. تحديد + Add Operation.
  3. في URL، حدد GET وأدخل /* في المورد.
  4. أدخل "WildcardGet" لاسم العرض.
  5. حدد حفظ.

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

اختبر العملية في بوابة Azure. يمكنك أيضاً اختباره في Developer portal.

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

  2. حدد WildcardGet. جرب عمليات GET التي اختبرتها في الأقسام السابقة، أو جرب عملية GET مدعومة مختلفة.

    على سبيل المثال، في معلمات القالب، قم بتحديث القيمة الموجودة بجوار اسم البدل (*) إلى headers . تقوم العملية بالتراجع عن رؤوس HTTP للطلب الوارد.

  3. اضغط Send.

    يظهر الرد الذي تولده العملية "http://httpbin.org/headers". إذا كنت ترغب في تحويل عملياتك، راجع تحويل واجهة برمجة التطبيقات وحمايتها.

إشعار

قد يكون من المهم أن تفهم كيف يتعامل مضيف واجهة API الخلفية التي تدمجها مع مقابض مائلة على عنوان URL للعملية. لمزيد من المعلومات، راجع الأسئلة المتداولة حول APIM.

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

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

  • مواصفات 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. حدّد خدمة لاستيراد واجهة برمجة تطبيقات منها.

    تحديد خدمة

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

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