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

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

توضح هذه المقالة كيفية استيراد خدمة OData باستخدام وصف بيانات التعريف الخاصة بها. يتم استخدام SAP Gateway Foundation كمثال.

في هذه المقالة، ستتمكن من:

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

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

• مثيل API Management. إذا لم يكن لديك مثيل، فأكمل الخطوات الواردة في إنشاء مثيل APIM باستخدام مدخل Microsoft Azure.

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

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

  1. في مدخل Microsoft Azure، ضمن واجهات برمجة التطبيقات، حدد Backends>+ Add.
  2. إضافة عنوان URL مخصص يشير إلى خدمة الواجهة الخلفية ل SAP.
  3. قم بإلغاء تحديد خانتي الاختيار التحقق من صحة سلسلة الشهاداتوالتحقق من صحة اسم الشهادة .

  ملاحظة

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

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

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

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

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

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

   

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

   

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

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

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

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

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

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

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

   

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

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

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

4. حدد إنشاء.

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

   

تحديث مخطط OData

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

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

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

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

   

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

   

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

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

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

   

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

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

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

تلميح

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

مواصفات OpenAPI

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

1. تحويل OData XML إلى تنسيق OpenAPI JSON. استخدم أداة OASIS مفتوحة المصدر لـ OData v2 أو OData v4، اعتماداً على XML لبيانات التعريف الخاصة بك.

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

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   ملاحظة

   • للاختبار باستخدام ملف XML واحد، يمكنك استخدام محول مستند إلى الويب يستند إلى أداة مفتوحة المصدر.
   • باستخدام الأداة أو المحول المستند إلى الويب، يعد تحديد <عنوان IP>:<منفذ> خادم SAP OData اختيارياً. بدلا من ذلك، أضف هذه المعلومات لاحقا في مواصفات OpenAPI التي تم إنشاؤها أو بعد استيراد الملف إلى APIM.

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

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

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

2. ضمن إنشاء تعريف جديد، حدد OpenAPI:

   

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

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

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

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

5. حدد إنشاء.

ملاحظة

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

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

أضف العمليات الثلاث التالية إلى واجهة برمجة التطبيقات التي قمت باستيرادها:

• GET /$metadata

  العملية	‏‏الوصف	تكوين إضافي للعملية
  GET /$metadata	تمكين إدارة واجهة برمجة التطبيقات من الوصول $metadata إلى نقطة النهاية، المطلوبة لتكامل العميل مع خادم OData. هذه العملية المطلوبة غير مضمنة في مواصفات OpenAPI التي أنشأتها واستوردتها.	إضافة 200 OK استجابة.

  

• HEAD /

  العملية	‏‏الوصف
  HEAD /	تمكين العميل من تبادل الرموز المميزة لتزوير الطلب عبر المواقع (CSRF) مع خادم SAP عند الحاجة. يسمح SAP أيضا بتبادل الرمز المميز CSRF عبر فعل GET. لم يتم تغطية تبادل الرمز المميز لـ CSRF في هذه المقالة. راجع مثال على مقتطف نهج إدارة واجهة برمجة التطبيقات لتبادل الرمز المميز للوسيط.

  

• GET /

  العملية	‏‏الوصف	تكوين إضافي للعملية
  GET /	تمكين تكوين النهج في جذر الخدمة.	قم بتكوين نهج rewrite-uri الوارد التالي لإلحاق شرطة مائلة زائدة بالطلبات التي تتم إعادة توجيهها إلى جذر الخدمة: <rewrite-uri template="/" copy-unmatched-params="true" /> يزيل هذا النهج الغموض المحتمل بين الطلبات مع الشرطة المائلة اللاحقة وبدونها. يتم التعامل مع هذين النوعين من الطلبات بشكل مختلف من قبل بعض الخلفيات.

  

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

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

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

2. في جزء التنقل الأيمن، في قسم واجهات برمجة التطبيقات ، حدد واجهات برمجة التطبيقات.

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

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

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

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

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

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

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

• راجع مثالا لسيناريو شامل لدمج إدارة واجهة برمجة التطبيقات مع بوابة SAP.
• التحكم في الوصول إلى واجهة SAP الخلفية باستخدام نهج APIM. على سبيل المثال، إذا تم استيراد واجهة برمجة التطبيقات كواجهة برمجة تطبيقات OData، فاستخدم نهج طلب التحقق من صحة OData. هناك أيضا أجزاء نهج لنشر SAP الأساسي ل SAP ECC أو S/4HANA أو SAP SuccessFactorsوجلب رمز X-CSRF المميز.
• للحصول على إرشادات حول نشر واجهات برمجة التطبيقات وإدارتها وترحيلها على نطاق واسع، راجع:
  • عمليات نشر واجهة برمجة التطبيقات التلقائية باستخدام APIOps.
  • CI/CD لـ APIM باستخدام قوالب Azure Resource Manager.

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

• قيود استيراد API
• استيراد مواصفة OpenAPI
• استيراد واجهة برمجة تطبيقات SOAP
• استيراد واجهة برمجة تطبيقات SOAP وتحويلها إلى REST
• استيراد واجهة برمجة تطبيقات App Service
• استيراد واجهة برمجة تطبيقات تطبيق حاوية
• استيراد واجهة برمجة تطبيقات WebSocket
• استيراد واجهة برمجة تطبيقات GraphQL
• استيراد مخطط GraphQL وإعداد محللات الحقول
• استيراد Azure Function App API
• استيراد Azure Logic App API
• استيراد خدمة Service Fabric
• استيراد واجهة برمجة تطبيقات Azure OpenAI
• استيراد واجهة برمجة تطبيقات OData
• استيراد بيانات التعريف لـ SAP OData
• استيراد واجهة برمجة تطبيقات gRPC
• تحرير واجهة برمجة تطبيقات