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

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

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

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

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

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

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

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

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

  

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

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

  

ما هي لقطة لمواصفات 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. انقر على Next (التالي).

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

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

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

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

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

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

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

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

أخذ لقطة للمواصفات

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

لأخذ لقطة من مواصفات OpenAPI:

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

4. انقر على

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

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

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

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

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

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

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

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

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

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

لإدارة شريحة جمهور واجهة برمجة التطبيقات على بوابتك:

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

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

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

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

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

عند استخدام "التجربة"، في حال عرض الخطأ TypeError: Failed to fetch، ضع في اعتبارك الأسباب والحلول المحتملة التالية:

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

   schemes:
     - https
     - http
  

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