مشاركة عبر

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

  • مقالة

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

توضح هذه المقالة كيفية استيراد خدمة متوافقة مع OData كواجهة برمجة تطبيقات في APIM.

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

  • استيراد وصف بيانات تعريف OData باستخدام مدخل Microsoft Azure
  • إدارة مخطط OData في المدخل
  • تأمين واجهة برمجة تطبيقات OData

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

  • مثيل API Management. إذا لم يكن لديك واحد بالفعل، فأكمل التشغيل السريع التالي: إنشاء مثيل إدارة واجهة برمجة تطبيقات Azure.

  • خدمة مكشوفة ك OData v2 أو v4.

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

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

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

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

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

استيراد بيانات تعريف OData

  1. في القائمة اليسرى، حدد APIs>+ Add API.

  2. ضمن إنشاء من التعريف، حدد OData.

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

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

    1. في مواصفات OData، أدخل عنوان URL لنقطة نهاية بيانات تعريف OData، وعادة ما يكون عنوان URL لجذر الخدمة، ملحقا ب /$metadata. بدلا من ذلك، حدد ملف OData XML محليا لاستيراده.

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

  4. حدد إنشاء.

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

    لقطة شاشة لمجموعات ووظائف كيان OData في المدخل.

تحديث مخطط OData

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

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

  2. في القائمة اليسرى، حدد واجهات برمجة التطبيقات> API OData الخاصة بك.

  3. في علامة التبويب Entity sets and functions ، حدد قائمة السياق (...) بجوار مجموعة كيان أو دالة، وحدد Edit.

    لقطة شاشة لقائمة السياق الخاصة بكيان OData الذي تم تعيينه في المدخل.

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

    لقطة شاشة لمحرر المخطط لواجهة برمجة تطبيقات OData في المدخل.

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

  1. في القائمة اليسرى، حدد واجهات برمجة التطبيقات> API OData الخاصة بك.

  2. في علامة التبويب Entity sets and functions ، حدد قائمة السياق (...) بجوار مجموعة كيان أو دالة، وحدد Test.

    لقطة شاشة لخيار Test في قائمة السياق الخاصة بكيان OData الذي تم تعيينه في المدخل.

  3. في وحدة تحكم الاختبار، أدخل معلمات القالب ومعلمات الاستعلام ورؤوس الاختبار، وحدد Test. تعرف على المزيد حول اختبار واجهة برمجة التطبيقات في المدخل.

تأمين واجهة برمجة تطبيقات OData

قم بتأمين واجهة برمجة تطبيقات OData الخاصة بك عن طريق تطبيق نهج المصادقة والتخويل الحالية ونهج التحقق من صحة OData للحماية من الهجمات من خلال طلبات واجهة برمجة تطبيقات OData.

تلميح

في المدخل، قم بتكوين النهج لواجهة برمجة تطبيقات OData في علامة التبويب نهج واجهة برمجة التطبيقات.

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

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

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

    تحديد خدمة