إدارة المواصفات

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

يوفّر لك Apigee Edge مكانًا لتخزين مواصفات OpenAPI. يمكنك إدارة مواصفات OpenAPI كما هو موضَّح في الأقسام التالية.

لمزيد من المعلومات عن مواصفات OpenAPI، يُرجى الاطّلاع على ما هي مواصفات OpenAPI؟

استكشاف قائمة المواصفات

للوصول إلى قائمة المواصفات:

  1. سجِّل الدخول إلى apigee.com/edge.
  2. تحديد مؤسسة
  3. انقر على تطوير > المواصفات في قائمة التنقّل الجانبية.

يتم عرض القائمة الحالية للمواصفات والمجلدات.

قائمة المواصفات

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

إنشاء مواصفة OpenAPI جديدة

لإنشاء مواصفة OpenAPI جديدة:

  1. انقر على تطوير > المواصفات في شريط التنقّل الجانبي.
  2. انقر على + مواصفة.
  3. انقر على مواصفة جديدة في القائمة المنسدلة. يتم فتح محرِّر المواصفات.
  4. استبدِل نموذج المواصفات بتفاصيل مواصفات OpenAPI الخاصة بك.
    راجِع مقالة إنشاء المواصفات باستخدام محرِّر المواصفات.
  5. انقر على حفظ لحفظ المواصفة.
  6. أدخِل اسمًا للمواصفة عندما يُطلب منك ذلك.
  7. انقر على حفظ.

استيراد مواصفات OpenAPI

لاستيراد مواصفات OpenAPI:

  1. انقر على تطوير > المواصفات في شريط التنقّل الجانبي.
  2. انقر على + مواصفة.
  3. انقر على أحد الخيارات التالية من القائمة المنسدلة:
    • استيراد عنوان URL لاستيراد المواصفة من عنوان URL حدِّد الاسم وعنوان URL عندما يُطلب منك ذلك.
    • استيراد ملف لتصفح الدليل المحلي بحثًا عن المواصفة
      تتم إضافة المواصفة إلى القائمة.
  4. انقر على اسم المواصفة لعرضها وتعديلها في محرِّر المواصفات.
    راجِع مقالة إنشاء المواصفات باستخدام محرِّر المواصفات.

تعديل مواصفات OpenAPI حالية

لفتح مواصفة OpenAPI حالية:

  1. انقر على تطوير > المواصفات في شريط التنقّل الجانبي.
  2. انقر على الصف المرتبط بالمواصفة في قائمة المواصفات.
  3. عدِّل المواصفة في محرِّر المواصفات.
    راجِع مقالة إنشاء المواصفات باستخدام محرِّر المواصفات.

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

باستخدام Apigee Edge، يمكنك إنشاء أدوات الربط لواجهات برمجة التطبيقات من مواصفات OpenAPI التي صمّمتها وحفظتها في محرِّر المواصفات. وببضع نقرات فقط، ستحصل على وكيل لواجهة برمجة التطبيقات في Apigee Edge مع المسارات والمَعلمات والمخططات الشَرطية ونقاط النهاية المستهدَفة التي يتم إنشاؤها تلقائيًا. بعد ذلك، يمكنك إضافة ميزات مثل أمان OAuth وتقييد معدّل الإرسال والتخزين المؤقت.

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

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

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

إعادة تسمية مواصفة

لإعادة تسمية مواصفة، اتّبِع الخطوات التالية:

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

نقل مواصفة إلى مجلد

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

حذف مواصفة

يمكنك حذف مواصفة من "متجر الملفات" عندما لا تكون مطلوبة أو تصبح غير صالحة.

لحذف مواصفة:

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