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

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

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

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

تتكوّن عملية نشر واجهات برمجة التطبيقات في البوابة من خطوتين:

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

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

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

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

  

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

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

  

ما هي نبذة عن مواصفات OpenAPI؟

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

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

إضافة دعم CORS إلى الخوادم الوكيلة لواجهة برمجة التطبيقات

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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) للخادم الوكيل لواجهة برمجة التطبيقات. تأكد من تفعيل سياسة مشاركة الموارد المتعددة المصادر (CORS) في متصفحك أيضًا.