مشاركة عبر

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

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

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

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

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

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

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

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

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

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

    لقطة شاشة تعرض خدمات APIM في نتائج البحث.

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

    لقطة شاشة تعرض مثيل APIM في صفحة خدمات APIM.

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

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

  2. ضمن Create from definition، حدد OData:

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

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

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

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

  4. حدد إنشاء.

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

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

تحديث مخطط OData

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

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

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

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

    لقطة شاشة تعرض موقع الأمر تحرير.

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

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

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

  1. في القائمة اليسرى، حدد واجهات برمجة التطبيقات، ثم حدد واجهة برمجة تطبيقات OData.

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

    لقطة شاشة تعرض الأمر Test.

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

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

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

تلميح

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

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

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

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

إشعار

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

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

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

    لقطة شاشة تعرض صفحة خدمات APIM.

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

    لقطة شاشة تعرض تحديد واجهات برمجة التطبيقات في صفحة نظرة عامة.

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

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

    لقطة شاشة تعرض الأمر استيراد.

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

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

  • Last updated on