نشر واجهات برمجة التطبيقات (الإصدار الأصلي)

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

انشر واجهات برمجة التطبيقات في البوابة لإتاحتها لمطوّري التطبيقات، كما هو موضّح في الأقسام التالية.

نظرة عامة على نشر واجهات برمجة التطبيقات

تتألف عملية نشر واجهات برمجة التطبيقات على البوابة من خطوتَين:

1. اختَر منتج واجهة برمجة التطبيقات الذي تريد نشره في البوابة.
2. يمكنك إنشاء مستندات مرجعية لواجهة برمجة التطبيقات تلقائيًا من لقطة لمواصفات OpenAPI لتتيح لمطوّري التطبيقات التعرّف على واجهات برمجة التطبيقات. (لمزيد من المعلومات عن اللقطات، يُرجى الاطّلاع على ما هي لقطة من مواصفات OpenAPI؟

عند نشر واجهة برمجة تطبيقات على البوابة، يتم إجراء التعديلات التالية على البوابة تلقائيًا:

• تتم إضافة صفحة "مرجع واجهة برمجة التطبيقات" إلى البوابة
  تعرض صفحة "مرجع واجهة برمجة التطبيقات" مستندات مرجع واجهة برمجة التطبيقات التي يتم إنشاؤها تلقائيًا من لقطة لمواصفات OpenAPI. يمكن للمطوّرين مراجعة مستندات واجهة برمجة التطبيقات والنقر على تجربة لإرسال طلب بيانات من واجهة برمجة التطبيقات وعرض الناتج.

  ملاحظة: لا يمكنك تعديل محتوى هذه الصفحة مباشرةً، فهي لا تظهر في قائمة الصفحات في البوابة.

  

• تمت إضافة رابط إلى صفحة "مرجع واجهة برمجة التطبيقات" في صفحة "واجهات برمجة التطبيقات"
  تقدّم صفحة "واجهات برمجة التطبيقات" (المضمّنة في البوابة النموذجية) قائمة بجميع واجهات برمجة التطبيقات المنشورة في البوابة مع روابط إلى مستندات مرجع واجهة برمجة التطبيقات المعنية للحصول على مزيد من المعلومات.

  ملاحظة: لا يمكنك تعديل محتوى هذه الصفحة مباشرةً، فهي لا تظهر في قائمة الصفحات في البوابة.

  

ما هي لقطة من مواصفات OpenAPI؟

تعمل كل مواصفة OpenAPI كمصدر للحقيقة طوال دورة حياة واجهة برمجة التطبيقات. يتم استخدام المواصفات نفسها في كل مرحلة من مراحل دورة حياة واجهة برمجة التطبيقات، بدءًا من التطوير والنشر وصولاً إلى المراقبة. عند تعديل مواصفات، يجب أن تكون على دراية بتأثير التغييرات في واجهة برمجة التطبيقات خلال مراحل أخرى من دورة الحياة، كما هو موضّح في ماذا يحدث إذا عدّلتُ المواصفات؟

عند نشر واجهة برمجة التطبيقات، يمكنك أخذ لقطة من مواصفات OpenAPI لإنشاء مستندات مرجعية لواجهة برمجة التطبيقات. تمثّل هذه اللقطة إصدارًا محدّدًا من المواصفات في مستودع المواصفات. إذا عدّلت مواصفات OpenAPI باستخدام أداة تعديل المواصفات، يمكنك اتّخاذ قرار بأخذ لقطة أخرى من المواصفات لعرض آخر التغييرات في مستندات مرجع واجهة برمجة التطبيقات.

إضافة إمكانية استخدام سياسة مشاركة الموارد المتعدّدة المصادر (CORS) إلى خوادم وكيل API

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

مشاركة الموارد المتعدّدة المصادر (CORS) هي آلية عادية تتيح لطلبات JavaScript XMLHttpRequest (XHR)‎ التي يتم تنفيذها في صفحة ويب التفاعل مع موارد من نطاقات غير المصدر. مشاركة الموارد المتعدّدة المصادر (CORS) هي حلّ شائع التنفيذ لسياسة المصدر نفسه التي تفرضها جميع المتصفحات. على سبيل المثال، إذا أجريت طلب XHR إلى Twitter API من رمز JavaScript يتم تنفيذه في متصفّحك، سيتعذّر تنفيذ الطلب. ويرجع ذلك إلى أنّ النطاق الذي يعرض الصفحة على متصفّحك ليس هو نفسه النطاق الذي يعرض واجهة برمجة التطبيقات Twitter API. تقدّم مشاركة الموارد المتعدّدة المصادر (CORS) حلاً لهذه المشكلة من خلال السماح للخوادم "بالموافقة" إذا كانت تريد توفير مشاركة الموارد المتعدّدة المصادر.

للحصول على معلومات حول إضافة إمكانية استخدام سياسة مشاركة الموارد المتعددة المصادر (CORS) إلى خوادم API الوكيلة قبل نشر واجهات برمجة التطبيقات، يُرجى الاطّلاع على إضافة إمكانية استخدام سياسة مشاركة الموارد المتعددة المصادر (CORS) إلى خادم API وكيل.

ملاحظة: تفرض معظم المتصفّحات الحديثة سياسة مشاركة الموارد المتعدّدة المصادر (CORS). راجِع قائمة المتصفّحات المتوافقة الشاملة. للحصول على وصف تفصيلي حول مشاركة المراجع مع نطاقات خارجية، يُرجى الاطّلاع على اقتراح مشاركة المراجع مع نطاقات خارجية من W3C.

استكشاف صفحة "واجهات برمجة التطبيقات"

للوصول إلى صفحة واجهات برمجة التطبيقات، اتّبِع الخطوات التالية:

1. انقر على نشر > البوابات واختَر بوابتك.
2. انقر على واجهات برمجة التطبيقات في الصفحة الرئيسية للبوابة.

بدلاً من ذلك، يمكنك النقر على واجهات برمجة التطبيقات في القائمة المنسدلة الخاصة بالبوابة في شريط التنقّل العلوي.

يتم عرض قائمة بواجهات برمجة التطبيقات.

كما هو موضّح في الشكل السابق، تتيح لك صفحة "واجهات برمجة التطبيقات" إجراء ما يلي:

• عرض تفاصيل واجهات برمجة التطبيقات المتاحة على البوابة
• إضافة واجهة برمجة تطبيقات إلى البوابة
• أخذ لقطة من مواصفات OpenAPI المرتبطة بأحد منتجات واجهة برمجة التطبيقات لتعديل المستندات المرجعية الخاصة بواجهة برمجة التطبيقات
• نشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة
• إدارة الجمهور المستهدف لواجهة برمجة التطبيقات على البوابة
• عدِّل المواصفات المرتبطة (راجِع إنشاء مواصفات باستخدام أداة تعديل المواصفات).
• إزالة واجهة برمجة تطبيقات من البوابة
• تحديد واجهات برمجة التطبيقات "اليتيمة" بسرعة والتي تمت إزالة منتج واجهة برمجة التطبيقات المرتبط بها من Edge، وإعادة إنشاء منتج واجهة برمجة التطبيقات أو حذف واجهة برمجة التطبيقات من البوابة

إضافة واجهة برمجة تطبيقات إلى البوابة

ملاحظة: يمكنك إضافة 100 واجهة برمجة تطبيقات كحد أقصى إلى البوابة.

لإضافة واجهة برمجة تطبيقات إلى البوابة، اتّبِع الخطوات التالية:

1. انقر على نشر > البوابات واختَر بوابتك.
2. انقر على واجهات برمجة التطبيقات في الصفحة الرئيسية للبوابة.
   بدلاً من ذلك، يمكنك اختيار واجهات برمجة التطبيقات من القائمة المنسدلة الخاصة بالبوابة في شريط التنقل العلوي.
3. انقر على + واجهة برمجة التطبيقات.
   يظهر مربّع الحوار "إضافة منتج API إلى البوابة".

4. في علامة التبويب "منتج واجهة برمجة التطبيقات" ضمن مربّع الحوار، اختَر منتج واجهة برمجة التطبيقات الذي تريد إضافته إلى البوابة.
   

5. انقروا على التالي.

6. اختَر المصدر الذي تريد استخدامه للّقطة.
   إذا أنشأت خادم وكيل لواجهة برمجة التطبيقات مضمّنًا في منتج واجهة برمجة التطبيقات باستخدام مواصفات OpenAPI، اختَر المواصفات من القائمة المنسدلة.
   

   بدلاً من ذلك، يمكنك اختيار:

   • بدون مواصفات وإضافة مواصفات لاحقًا بعد نشر واجهة برمجة التطبيقات، كما هو موضّح في أخذ لقطة من المواصفات
   • اختَر مواصفات مختلفة لاختيار مواصفات جديدة أو تحميلها.

7. ضَع علامة في مربّع الاختيار تم النشر لنشر واجهة برمجة التطبيقات في البوابة. أزِل العلامة من المربّع بجانب تم النشر إذا لم تكن مستعدًا لنشر واجهة برمجة التطبيقات.
   يمكنك تغيير الإعداد لاحقًا، كما هو موضّح في نشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة.

8. ضمن "الجمهور"، حدِّد أحد الخيارات التالية لإدارة الجمهور المستهدَف لواجهة برمجة التطبيقات من خلال السماح بالوصول إلى:

   • المستخدمون المجهولون للسماح لجميع المستخدمين بعرض الصفحة
   • المستخدمون المسجّلون للسماح للمستخدمين المسجّلين فقط بعرض الصفحة

   يمكنك تغيير الإعداد لاحقًا، كما هو موضّح في إدارة الجمهور لواجهة برمجة التطبيقات على البوابة.

9. انقر على إنهاء.

التقاط لقطة من المواصفات

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

للحصول على لقطة من مواصفات OpenAPI، اتّبِع الخطوات التالية:

1. انقر على نشر > البوابات واختَر بوابتك.
2. انقر على واجهات برمجة التطبيقات في الصفحة الرئيسية للبوابة.
   بدلاً من ذلك، يمكنك اختيار واجهات برمجة التطبيقات من القائمة المنسدلة الخاصة بالبوابة في شريط التنقل العلوي.
3. ضَع المؤشر فوق واجهة برمجة التطبيقات التي تريد أخذ لقطة لها لعرض الإجراءات.

4. انقر على .

   ملاحظة: يتم عرض رسالة إذا كانت اللقطة الحالية تتضمّن مواصفات المصدر المحدّدة.

5. اختَر مواصفات حالية من القائمة المنسدلة "مصدر اللقطة" أو انقر على اختيار مواصفات مختلفة لاختيار مواصفات جديدة أو تحميلها لاستخدامها في إنشاء مستندات لواجهة برمجة التطبيقات. يمكنك بدلاً من ذلك اختيار بدون مواصفات لإزالة المواصفات الحالية.

6. انقر على تعديل اللقطة (أو إزالة اللقطة، إذا اخترت "لا يوجد مواصفات").

يتم إنشاء مستندات مرجع واجهة برمجة التطبيقات من المواصفات وإضافتها إلى صفحة "مرجع واجهة برمجة التطبيقات".

نشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة

لنشر واجهة برمجة تطبيقات أو إلغاء نشرها على البوابة، اتّبِع الخطوات التالية:

1. انقر على نشر > البوابات واختَر بوابتك.
2. انقر على واجهات برمجة التطبيقات في الصفحة الرئيسية للبوابة.
   بدلاً من ذلك، يمكنك اختيار واجهات برمجة التطبيقات من القائمة المنسدلة الخاصة بالبوابة في شريط التنقل العلوي.
3. ضَع المؤشر فوق واجهة برمجة التطبيقات التي تريد نشرها أو إلغاء نشرها.
4. انقر على .
5. ضَع علامة في مربّع الاختيار مفعَّلة لنشر واجهة برمجة التطبيقات على البوابة. أزِل العلامة من المربّع مفعّلة لإلغاء نشر واجهة برمجة التطبيقات.
6. انقر على حفظ.

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

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

• كل المستخدمين
• المستخدمون المسجَّلون فقط

لإدارة الجمهور المستهدف لواجهة برمجة تطبيقات على البوابة، اتّبِع الخطوات التالية:

1. انقر على نشر > البوابات واختَر بوابتك.
2. انقر على واجهات برمجة التطبيقات في الصفحة الرئيسية للبوابة.
   بدلاً من ذلك، يمكنك اختيار واجهات برمجة التطبيقات من القائمة المنسدلة الخاصة بالبوابة في شريط التنقل العلوي.
3. ضَع المؤشر فوق واجهة برمجة التطبيقات التي تريد إدارة الجمهور لعرض الإجراءات.
4. انقر على .
5. ضمن "الجمهور"، حدِّد أحد الخيارات التالية:
   • المستخدمون المجهولون للسماح لجميع المستخدمين بالاطّلاع على منتج واجهة برمجة التطبيقات
   • المستخدمون المسجّلون للسماح للمستخدمين المسجّلين فقط بعرض منتج واجهة برمجة التطبيقات
6. انقر على حفظ.

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

لإزالة واجهة برمجة تطبيقات من البوابة، اتّبِع الخطوات التالية:

1. انقر على نشر > البوابات واختَر بوابتك.
2. انقر على واجهات برمجة التطبيقات في الصفحة الرئيسية للبوابة.
   بدلاً من ذلك، يمكنك اختيار واجهات برمجة التطبيقات من القائمة المنسدلة الخاصة بالبوابة في شريط التنقل العلوي.
3. ضَع مؤشر الماوس فوق واجهة برمجة التطبيقات في القائمة لعرض قائمة الإجراءات.
4. انقر على .

تحديد المشاكل في واجهات برمجة التطبيقات المنشورة وحلّها

عند استخدام ميزة "تجربة"، إذا تم عرض الخطأ TypeError: Failed to fetch، يُرجى مراعاة الأسباب والحلول المحتملة التالية:

• بالنسبة إلى أخطاء المحتوى المختلط، قد يكون الخطأ ناتجًا عن مشكلة معروفة في swagger-ui. أحد الحلول الممكنة هو التأكّد من تحديد HTTPS قبل HTTP في تعريف schemes في مواصفات OpenAPI. على سبيل المثال:

   schemes:
     - https
     - http
  

• بالنسبة إلى أخطاء القيود المفروضة على مشاركة الموارد متعدّدة المصادر (CORS)، تأكَّد من أنّ هذه الميزة متاحة لخوادم وكيل واجهة برمجة التطبيقات. بروتوكول مشاركة الموارد المشتركة المنشأ (CORS) هو آلية عادية تتيح الطلبات متعدّدة المصادر من جهة العميل. يُرجى الاطّلاع على إضافة إمكانية استخدام CORS لخادم وكيل لواجهة برمجة التطبيقات. تأكَّد من تفعيل سياسة مشاركة الموارد المتعددة المصادر (CORS) في المتصفّح أيضًا.