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

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

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

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

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

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

• مثيل APIM موجود. أنشئ واحد إذا لم تكن قد قمت بذلك بالفعل.

• نظام 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)، أو
• قم بإجراء استدعاء 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. ضمن إنشاء من التعريف، حدد OData.

   

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

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

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

4. حدد إنشاء.

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

   

تحديث مخطط OData

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

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

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

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

   

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

   

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

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

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

   

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

تأمين واجهة برمجة تطبيقات 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.

استيراد ونشر واجهة برمجة تطبيقات خلفية

1. من قائمة التنقل الجانبية، ضمن قسم واجهات برمجة التطبيقات، حدد واجهات برمجة التطبيقات.

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

   

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

4. أدخل إعدادات واجهة برمجة التطبيقات. يمكنك تعيين القيم أثناء الإنشاء أو تهيئتها لاحقاً بالانتقال إلى علامة التبويب Settings.

   • في لاحقة عنوان 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 الأساسي وجلب رمز X-CSRF المميز.
• للحصول على إرشادات لنشر واجهات برمجة التطبيقات وإدارتها وترحيلها على نطاق واسع، راجع:
  • عمليات النشر الآلي لواجهة برمجة التطبيقات مع APIOps
  • CI/CD لـ APIM باستخدام قوالب Azure Resource Manager.

المواضيع ذات الصلة

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