استيراد بيانات تعريف SAP OData كواجهة برمجة تطبيقات

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

تصف هذه المقالة كيفية استيراد خدمة OData (بروتوكول البيانات المفتوحة) إلى إدارة API في Azure باستخدام بيانات وصفية OData. المثال التالي يستخدم SAP Gateway Foundation.

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

  • استرداد بيانات تعريف OData من خدمة SAP
  • استيراد بيانات OData الوصفية إلى إدارة Azure API، إما مباشرة أو بعد تحويلها إلى مواصفة OpenAPI
  • تكوين واجهة برمجة التطبيقات الكامل
  • اختبر واجهة برمجة التطبيقات في بوابة Azure

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

  • أنشئ نسخة إدارة واجهة برمجة تطبيقات (API).

  • نظام SAP وخدمة يتم كشفها ك OData v2 أو v4.

  • إذا كانت واجهة SAP الخلفية تستخدم شهادة موقعة ذاتيا (للاختبار)، فقد تحتاج إلى تعطيل التحقق من سلسلة الثقة ل SSL. للقيام بذلك، قم بتكوين خلفية في مثيل APIM الخاص بك:

    1. في بوابة Azure، تحت واجهات برمجة التطبيقات (APIs)، اختر Backends>+ Create backend جديدة.
    2. إضافة عنوان URL مخصص يشير إلى خدمة الواجهة الخلفية ل SAP.
    3. قم بتوسيع قسم المتقدمين ، ثم امسح خانات التحقق من صحة الشهاداتوالتحقق من أسماء الشهادة .

    إشعار

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

    تلميح

    للحصول على نطاق الميزات الكامل لإدارة الواجهات، قم بتحويل واجهة برمجة تطبيقات SAP OData إلى مواصفة OpenAPI قبل التسجيل.

استرداد بيانات تعريف OData من خدمة SAP

استخدم إحدى الطرق التالية لاسترداد بيانات التعريف XML من خدمة SAP. إذا كنت تخطط لتحويل بيانات التعريف XML إلى مواصفات OpenAPI، فاحفظ الملف محليا.

  • استخدم عميل بوابة SAP (المعاملة /IWFND/GW_CLIENT).
  • قم بإجراء استدعاء HTTP مباشر لاسترداد XML: http://<OData server URL>:<port>/<path>/$metadata.
  • استخدم مركز SAP Business Accelerator Hub إذا كان ذلك مناسبا.

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

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

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

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

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

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

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

  • تحويل بيانات التعريف XML إلى مواصفة OpenAPI (موصى بها).
  • استيراد XML بيانات التعريف كواجهة برمجة تطبيقات OData مباشرة.

تحويل بيانات تعريف OData إلى OpenAPI JSON

  1. استخدم محول Microsoft المبني فوق أداة OASIS مفتوحة المصدر.

    يحول المثال التالي OData v2 XML لخدمة epm_ref_apps_prod_man_srvالاختبار :

    oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json

    إشعار

    للاختبار بملف XML واحد، يمكنك استخدام تجربة الويب.

  2. احفظ ملف openapi-spec.json محليا للاستيراد إلى إدارة API.

استيراد مواصفات OpenAPI

  1. في قائمة الشريط الجانبي، في قسم واجهات البرمجة (APIs )، اختر واجهات برمجة التطبيقات (APIs).

  2. تحت إنشاء من التعريف، اختر بلاطة OpenAPI :

    لقطة شاشة تعرض تجانب OpenAPI.

  3. اختر اختيار ملف، ثم اختر الملف openapi-spec.json الذي حفظته محليا في خطوة سابقة.

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

    • بالنسبة للاحقة عنوان URL لواجهة برمجة التطبيقات، نوصي باستخدام نفس مسار URL مثل مسار خدمة SAP الأصلية.

    • لمزيد من المعلومات بشأن إعدادات API، راجع استيراد ونشر أول API تعليمي.

  5. حدد إنشاء.

تحتاج أيضا إلى تكوين المصادقة إلى الخلفية باستخدام أسلوب مناسب للبيئة الخاصة بك. لأمثلة على ذلك، انظر المصادقة والتفويض.

إشعار

للحصول على معلومات حول قيود استيراد واجهة برمجة التطبيقات، راجع قيود استيراد واجهة برمجة التطبيقات والمشكلات المعروفة.

قم باختبار واجهة برمجة التطبيقات الخاصة بك

  1. انتقل إلى مثيل APIM الخاص بك.

  2. في قائمة الشريط الجانبي، اخترواجهات برمجة>).

  3. ضمن جميع واجهات برمجة التطبيقات، حدد واجهة برمجة تطبيقات المستوردة الخاصة بك.

  4. حدد علامة تبويب اختبار للوصول إلى وحدة الاختبار.

  5. حدد عملية، وأدخل أي قيم مطلوبة، ثم حدد إرسال.

    على سبيل المثال، اختبر GET /$metadata الاستدعاء للتحقق من الاتصال بواجهة SAP الخلفية.

  6. عرض الاستجابة. لاستكشاف الأخطاء وإصلاحها، تتبع المكالمة.

  7. عند الانتهاء من الاختبار، قم بإنهاء وحدة تحكم الاختبار.

اعتبارات الإنتاج

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

  • Last updated on