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

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

يوفر لك 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 التي تريد إنشاء وكيل API لها لعرض قائمة الإجراءات.
  4. انقر على إنشاء خادم وكيل يتم فتح معالج إنشاء خادم وكيل وتتم تعبئة صفحة تفاصيل الخادم الوكيل مسبقًا باستخدام قيم من مواصفات OpenAPI، كما هو موضح في الشكل التالي.
    إنشاء معالج خادم وكيل
  5. انقر على التالي.
  6. انتقِل خلال الصفحات المتبقية في معالج إنشاء خادم وكيل، كما هو موضح في إنشاء خادم وكيل لواجهة برمجة التطبيقات من مواصفات OpenAPI. (ابدأ من الخطوة 8.)

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

لإعادة تسمية إحدى المواصفات:

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

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

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

حذف إحدى المواصفات

يمكنك حذف إحدى المواصفات من مخزن الملفات عندما لا تعود مطلوبة أو عندما تصبح غير صالحة.

لحذف إحدى المواصفات:

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