الخطوة 6: نشر واجهة برمجة تطبيقات

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

في هذه الخطوة، ستنشر واجهة برمجة تطبيقات على البوابة من خلال تنفيذ الخطوات التالية:
1- إنشاء مواصفات OpenAPI
2. إنشاء خادم وكيل لواجهة برمجة التطبيقات من إحدى المواصفات
3. إنشاء منتج واجهة برمجة التطبيقات
4. نشر واجهة برمجة التطبيقات في بوابتك

الخطوة الأولى: إنشاء مواصفات OpenAPI

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

لإنشاء مواصفات OpenAPI:

1. اختَر التطوير > المواصفات في شريط التنقّل الأيمن لفتح صفحة المواصفات.
2. انقر على + المواصفات > استيراد عنوان URL.
3. أدخِل المعلومات التالية في مربّع حوار الاستيراد:
4. اسم الاستيراد: helloworld

5. عنوان URL للاستيراد: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

6. انقر على استيراد.

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

أنشئ خادمًا وكيلاً لواجهة برمجة التطبيقات من مواصفات OpenAPI التي تصف واجهة برمجة التطبيقات.

لإنشاء خادم وكيل لواجهة برمجة التطبيقات من مواصفات OpenAPI:

1. في صفحة المواصفات، ضَع المؤشر فوق مواصفات helloworld لعرض قائمة الإجراءات.
2. انقر على لإنشاء خادم وكيل لواجهة برمجة التطبيقات من المواصفات.
   يتم فتح معالج إنشاء خادم وكيل وتتم تعبئة صفحة "التفاصيل" مسبقًا باستخدام القيم الواردة من مواصفات OpenAPI.
3. عدِّل حقل الوصف على النحو التالي: خادم وكيل واجهة برمجة التطبيقات لتطبيق hello world.
4. انقر على Next (التالي).

5. في صفحة السياسات:

   • ضمن الأمان: التفويض، اختَر اجتياز (بدون تفويض).
   • ضِمن الأمان: المتصفّح، اختَر إضافة عناوين CORS .

   

6. انقر على Next (التالي).

7. في صفحة التدفقات، تأكَّد من اختيار جميع العمليات وانقر على التالي.
   

8. في صفحة "المضيفون الافتراضيون"، تأكد من اختيار جميع المضيفين الافتراضيين، ثم انقر على التالي.

9. في صفحة الملخّص، اختَر البيئة التي تريد النشر فيها ضمن النشر الاختياري.

   

10. انقر على إنشاء.

في صفحة "الملخص"، سيظهر لك إقرار بأنّ الخادم الوكيل الجديد لواجهة برمجة التطبيقات قد تم إنشاؤه بنجاح ونشره في بيئة الاختبار.

الخطوة 3: إنشاء منتج واجهة برمجة التطبيقات

أنشِئ منتجًا لواجهة برمجة تطبيقات يحتوي على موارد واجهة برمجة التطبيقات التي تريد عرضها لمستخدمي واجهة برمجة التطبيقات.

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

1. اختر نشر > منتجات واجهة برمجة التطبيقات في شريط التنقّل الأيمن لفتح صفحة "منتجات واجهة برمجة التطبيقات".
2. انقر على + منتج واجهة برمجة التطبيقات.
   يتم عرض صفحة "المنتج الجديد".
3. أدخِل Product Details (تفاصيل المنتج) للمنتج الذي تستخدمه في واجهة برمجة التطبيقات.
   ملاحظة: يتم عرض حقلَي "الاسم المعروض" و"الوصف" في البوابة عندما تنشر منتج واجهة برمجة التطبيقات تلقائيًا. يمكنك تعديل القيم في الخطوة 4: نشر واجهة برمجة التطبيقات على البوابة.
   

   الحقل	القيمة
   الاسم	مرحبًا
   الاسم المعروض	مرحبًا
   الوصف	مثال بسيط على حدث أهلاً بالعالم
   البيئة	اختَر البيئة التي يتم فيها تفعيل الخادم الوكيل لواجهة برمجة التطبيقات.
   إمكانية الوصول	علني
   الموافقة تلقائيًا على طلبات الوصول	مفعّلة
   الحصة	(اتركه فارغًا)
   نطاقات OAuth المسموح بها	(اتركه فارغًا)

4. ضمن موارد واجهة برمجة التطبيقات، انقر على إضافة خادم وكيل لتحديد الخوادم الوكيلة لواجهة برمجة التطبيقات التي تريد إضافتها إلى منتج واجهة برمجة التطبيقات.
   سيظهر مربّع الحوار إضافة مورد واجهة برمجة التطبيقات.
5. انقر على خادم وكيل واجهة برمجة التطبيقات (إذا لم يكن محدّدًا من قبل) وحدِّد Mock-Target-API في القائمة.
6. انقر على إضافة.
7. انقر على Save (حفظ) لحفظ منتج واجهة برمجة التطبيقات.

   

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

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

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

1. انتقِل إلى صفحة APIs في البوابة:
   1. حدّد نشر > البوابات في شريط التنقل الأيمن.
   2. انقر على صف البوابة الأولى لفتح البوابة.
   3. انقر على كتالوج واجهة برمجة التطبيقات لعرض صفحة واجهات برمجة التطبيقات.
2. انقر على +.
3. اختَر Hello World في مربّع الحوار إضافة منتج واجهة برمجة التطبيقات إلى الكتالوج وانقر على التالي.
4. ضمن تفاصيل واجهة برمجة التطبيقات، اضبط الخيارات التالية:
   • اختَر منشور (مدرج في الكتالوج) لنشر واجهة برمجة التطبيقات على بوابتك.
   • بالنسبة إلى الصورة المعروضة:
     1. انقر على اختيار صورة.
     2. انقر على home-background.jpg من قائمة الصور الحالية في مربّع الحوار اختيار صورة.
     3. النقر على اختيار
     4. عايِن الصورة وانقر على اختيار.
   • بالنسبة إلى الفئات، أدخِل البدء واضغط على Enter.

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

5. ضمن وثائق واجهة برمجة التطبيقات، يمكنك إنشاء مستندات مرجعية لواجهة برمجة التطبيقات تلقائيًا من لقطة من OpenAPI مواصفات:
   1. اختَر مستند OpenAPI.
   2. انقر على اختيار مستند.
   3. اختر علامة التبويب My Specs (مواصفاتي) (إذا لم تكن محدّدة مسبقًا).
   4. اختَر helloworld من قائمة المواصفات.
   5. النقر على اختيار
6. انقر على حفظ لحفظ تفاصيل واجهة برمجة التطبيقات.

   

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

1. انقر على البوابة المباشرة لعرض التغييرات في البوابة المباشرة (أو أعِد تحميل البوابة المباشرة إذا كانت مفتوحة في علامة تبويب أخرى).
2. انقر على واجهات برمجة التطبيقات في شريط التنقل العلوي للوصول إلى واجهة برمجة التطبيقات المنشورة.
3. انقر على بطاقة Hello World لعرض الوثائق المرجعية لواجهة برمجة التطبيقات. تجربة واجهة برمجة التطبيقات

---

تهانينا! لقد أكملت البرنامج التعليمي بنجاح. هل تريد مزيدًا من المعلومات؟ انتقِل إلى إنشاء البوابة المتكاملة.