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

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

تتيح لك Apigee Edge عرض خدمات الخلفية بسرعة كواجهات برمجة تطبيقات. يمكنك إجراء ذلك عن طريق إنشاء خادم وكيل لواجهة برمجة التطبيقات يوفّر واجهة للخدمة الخلفية التي تريد عرضها. ما عليك سوى تقديم عنوان الشبكة للخدمة الخلفية، بالإضافة إلى بعض المعلومات التي يستخدمها Edge لإنشاء الخادم الوكيل لواجهة برمجة التطبيقات الذي يظهر للمطوّرين.

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

شاهِد هذا الفيديو للحصول على نظرة عامة حول عملية إنشاء خادم وكيل لواجهة برمجة التطبيقات.

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

تتمثل أسهل طريقة لإنشاء خادم وكيل لواجهة برمجة التطبيقات في استخدام معالج إنشاء خادم وكيل.

Edge

للوصول إلى معالج إنشاء خادم وكيل باستخدام واجهة مستخدم Edge:

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

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

الصفحة الأولى من معالج "إنشاء خادم وكيل" تطلب منك تحديد الوكيل العكسي أو خدمة SOAP أو عدم الاستهداف أو حزمة الخادم الوكيل لتخصيص مسار المعالج.

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

للوصول إلى معالج "إنشاء خادم وكيل" باستخدام واجهة مستخدم الإصدار الكلاسيكي من Edge:

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث يشير ms-ip إلى عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. حدد واجهات برمجة التطبيقات > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل العلوي.
  3. انقر على + الخادم الوكيل لواجهة برمجة التطبيقات.

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

الصفحة الأولى من معالج "إنشاء خادم وكيل" تطلب منك تحديد الوكيل العكسي أو خدمة SOAP أو عدم الاستهداف أو حزمة الخادم الوكيل لتخصيص مسار المعالج.

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

Type الوصف
الوكيل العكسي (الأكثر شيوعًا)

يشير هذا المصطلح إلى خادم وكيل لواجهة برمجة التطبيقات يوجِّه الطلبات الواردة إلى خدمات الواجهة الخلفية لبروتوكول HTTP الحالية. ويمكن أن تكون واجهة برمجة التطبيقات JSON أو XML. راجع إنشاء وكيل عكسي لخدمة HTTP لاحقًا في هذا القسم.

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

خدمة SOAP خادم وكيل لواجهة برمجة التطبيقات تم إنشاؤه من ملف WSDL. راجع عرض خدمة ويب مستندة إلى SOAP كخادم وكيل لواجهة برمجة التطبيقات.
بلا هدف

خادم وكيل لواجهة برمجة التطبيقات بدون خلفية لواجهة برمجة التطبيقات ("بدون استهداف"). إنّ هذه الطريقة تشبه إنشاء خادم وكيل عكسي لخدمة HTTP كما هو موضّح سابقًا، إلا أنّه لا يمكنك تحديد واجهة برمجة تطبيقات حالية عند تحديد تفاصيل الخادم الوكيل لواجهة برمجة التطبيقات.

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

الاستهداف المستضاف

خادم وكيل لواجهة برمجة التطبيقات يوجِّه إلى تطبيق Node.js الذي تم نشره في بيئة الأهداف المستضافة. يُرجى الاطّلاع على نظرة عامة على الأهداف المستضافة.

تحميل حزمة الخادم الوكيل حزمة خادم وكيل حالية لواجهة برمجة التطبيقات (على سبيل المثال، أحد نماذج الخوادم الوكيلة لواجهة برمجة التطبيقات المتاحة على GitHub). يُرجى الاطّلاع على استيراد خادم وكيل لواجهة برمجة التطبيقات من حزمة خادم وكيل لواجهة برمجة التطبيقات.

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

إنشاء وكيل عكسي لخدمة HTTP

ينشئ Edge خوادم وكيلة عكسية استنادًا إلى جزأين من المعلومات:

  • عنوان URL لخدمة الخلفية
  • مسار معرّف الموارد المنتظم (URI) الذي يحدّد واجهة برمجة التطبيقات بشكل فريد الذي سيعرضه الخادم الوكيل لواجهة برمجة التطبيقات لتطبيقات المستهلكين

يمثِّل عنوان URL لخدمة الخلفية عادةً تطبيقًا تفعّل الخدمة وتملكه مؤسستك. ويمكن أن يشير أيضًا إلى واجهة برمجة تطبيقات متاحة للجميع. يمكن أن تكون واجهة برمجة التطبيقات أو الخدمة خاضعة لسيطرتك (على سبيل المثال، تطبيق موارد بشرية داخلي أو تطبيق Rails في السحابة الإلكترونية) أو قد تكون واجهة برمجة تطبيقات أو خدمة تابعة لجهة خارجية (مثل Twitter أو Instagram).

Edge

  1. ادخل إلى معالج إنشاء خادم وكيل، كما هو موضح في إنشاء خادم وكيل لواجهة برمجة التطبيقات باستخدام واجهة المستخدم سابقًا في هذا القسم.
  2. في معالج إنشاء خادم وكيل، انقر على الخادم الوكيل العكسي (الأكثر شيوعًا). لإنشاء الخادم الوكيل من مواصفات OpenAPI حالية صالحة، انقر على استخدام مواصفات OpenAPI. للحصول على تفاصيل حول هذا الخيار، راجع استخدام مواصفات OpenAPI لإنشاء الخوادم الوكيلة أدناه.
  3. في صفحة التفاصيل للمعالج، أدخِل المعلومات التالية.
    الحقل الوصف
    الاسم الاسم المعروض لواجهة برمجة التطبيقات حدِّد أحرف أبجدية رقمية أو شَرطة (-) أو شرطة سفلية (_).
    مسار القاعدة

    جزء معرّف الموارد المنتظم (URI) الذي يظهر بعد عنوان http(s)://[host] للخادم الوكيل لواجهة برمجة التطبيقات يستخدم Edge معرّف الموارد المنتظم (URI) للمسار الأساسي لمطابقة رسائل الطلبات الواردة وتوجيهها إلى الخادم الوكيل الصحيح لواجهة برمجة التطبيقات.

    ملاحظة: يتم تلقائيًا تحويل المسار الأساسي للخادم الوكيل لواجهة برمجة التطبيقات إلى القيمة المحدّدة للحقل Name والتي تم تحويلها إلى أحرف صغيرة بالكامل.

    بعد المسار الأساسي، ستظهر أي عناوين URL إضافية للموارد. وفي ما يلي بنية عنوان URL الكاملة التي سيستخدمها العملاء لطلب الخادم الوكيل لواجهة برمجة التطبيقات:

    https://[host]/base_path/conditional_flow_path

    ملاحظة: يجب أن يكون المسار الأساسي فريدًا من نوعه، ولا يمكنك نشر خادمَين وكيلَين لواجهة برمجة التطبيقات باستخدام المسار الأساسي نفسه. إذا عدَّلت خادمًا وكيلاً تم نشره لواجهة برمجة التطبيقات وضبطت المسار الأساسي على القيمة نفسها للمسار الأساسي لخادم وكيل آخر لواجهة برمجة التطبيقات، يلغي Edge تلقائيًا نشر الخادم الوكيل لواجهة برمجة التطبيقات عند حفظه. قبل إعادة نشر الخادم الوكيل لواجهة برمجة التطبيقات، يجب تعديل المسار الأساسي بحيث يكون فريدًا.

    استخدام أحرف البدل في المسارات الأساسية

    استخدِم حرف بدل /*/ واحدًا أو أكثر في المسارات الأساسية للخادم الوكيل لواجهة برمجة التطبيقات لحماية الخوادم الوكيلة لواجهة برمجة التطبيقات في المستقبل. على سبيل المثال، يتيح المسار الأساسي في /team/*/members للعملاء الاتصال بـ https://[host]/team/blue/members وhttps://[host]/team/green/members بدون الحاجة إلى إنشاء خوادم وكيلة جديدة لواجهة برمجة التطبيقات من أجل دعم الفِرق الجديدة. يُرجى العلم أنّ السمة /**/ غير متوافقة.

    الوصف (اختياري) وصف واجهة برمجة التطبيقات.
    الاستهداف (واجهة برمجة التطبيقات الحالية) عنوان URL لخدمة الخلفية التي يستدعيها الخادم الوكيل لواجهة برمجة التطبيقات هذا.
  4. في صفحة السياسات الشائعة بالمعالج، اضبط ما يلي:
  5. في صفحة المضيفين الافتراضيين من المعالج، اختَر المضيفات الافتراضية التي سيربطها الخادم الوكيل لواجهة برمجة التطبيقات عند نشرها. لمزيد من المعلومات، راجع معلومات عن المضيفين الافتراضيين.
  6. في صفحة الملخّص، اختَر بيئات النشر، إذا أردت، وانقر على إنشاء ونشر.

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

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

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

  1. ادخل إلى معالج إنشاء خادم وكيل، كما هو موضح في إنشاء خادم وكيل لواجهة برمجة التطبيقات باستخدام واجهة المستخدم سابقًا في هذا القسم.
  2. في معالج إنشاء خادم وكيل، حدد الخادم الوكيل العكسي (الأكثر شيوعًا). لإنشاء الخادم الوكيل من مواصفات OpenAPI حالية وصالحة، انقر على استخدام OpenAPI. لمعرفة التفاصيل حول هذا الخيار، يُرجى الاطّلاع على استخدام مواصفات OpenAPI لإنشاء خوادم وكيلة أدناه.
  3. انقر على التالي.
  4. في صفحة التفاصيل للمعالج، أدخِل المعلومات التالية.
    الحقل الوصف
    اسم الخادم الوكيل الاسم المعروض لواجهة برمجة التطبيقات.
    المسار الأساسي للخادم الوكيل

    "المسار الأساسي للخادم الوكيل" هو جزء من عنوان URI بعد العنوان http(s)://[host] للخادم الوكيل لواجهة برمجة التطبيقات. يستخدم Edge معرّف الموارد المنتظم (URI) للمسار الأساسي لمطابقة رسائل الطلبات الواردة وتوجيهها إلى الخادم الوكيل الصحيح لواجهة برمجة التطبيقات.

    ملاحظة: للحصول على اقتراحات Apigee بشأن إصدارات واجهة برمجة التطبيقات، يُرجى الاطّلاع على الإصدار في الكتاب الإلكتروني Web API Design: The Missing Link.

    بعد المسار الأساسي، تظهر أي عناوين URL إضافية للموارد. في ما يلي بنية عنوان URL الكاملة التي سيستخدمها العملاء لطلب الخادم الوكيل لواجهة برمجة التطبيقات:

    https://[host]/base_path/conditional_flow_path

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

    استخدام حرف بدل في المسارات الأساسية

    يمكنك استخدام حرف بدل واحد أو أكثر من /*/ في المسارات الأساسية للخادم الوكيل لواجهة برمجة التطبيقات لحماية الخوادم الوكيلة في المستقبل. على سبيل المثال، يتيح المسار الأساسي في /team/*/members للعملاء الاتصال بـ https://[host]/team/blue/members وhttps://[host]/team/green/members بدون الحاجة إلى إنشاء خوادم وكيلة جديدة لواجهة برمجة التطبيقات من أجل دعم الفِرق الجديدة. ولا يمكن استخدام /**/.

    ملاحظة: يتم ضبط "المسار الأساسي للخادم الوكيل" تلقائيًا على القيمة المحدّدة لاسم الخادم الوكيل، مع تحويلها إلى أحرف صغيرة بالكامل ما لم تعدِّل المحتوى بشكلٍ صريح في حقل "مسار الخادم الوكيل" الأساسي.

    واجهة برمجة التطبيقات الحالية عنوان URL الذي تستدعيه واجهة برمجة التطبيقات نيابةً عن التطبيقات التي تستدعي واجهة برمجة التطبيقات من خلال عنوان URL للخادم الوكيل لواجهة برمجة التطبيقات.
    الوصف وصف واجهة برمجة التطبيقات.
  5. في صفحة الأمان بالمعالج، اضبط ما يلي:
  6. في صفحة المضيفين الافتراضيين من المعالج، اختَر المضيفات الافتراضية التي سيربطها الخادم الوكيل لواجهة برمجة التطبيقات عند نشرها. لمزيد من المعلومات، راجع معلومات عن المضيفين الافتراضيين.
  7. اختَر بيئات النشر وانقر على إنشاء ونشر
    يتم إرسال إقرار يؤكد إنشاء الخادم الوكيل الجديد لواجهة برمجة التطبيقات بنجاح ونشره في البيئة المحدّدة.
  8. انقر على عرض الخادم الوكيل <proxy name> في المحرِّر لعرض صفحة التفاصيل للخادم الوكيل لواجهة برمجة التطبيقات.

جارٍ استيراد خادم وكيل لواجهة برمجة التطبيقات من حزمة الخادم الوكيل لواجهة برمجة التطبيقات

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

يمكنك مشاهدة هذا الفيديو للتعرّف على كيفية إنشاء خادم وكيل لواجهة برمجة التطبيقات واستيراده من حزمة خادم وكيل لواجهة برمجة التطبيقات.

Edge

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

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

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

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

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

    الحقل الوصف
    حزمة ZIP انقر على اختيار ملف وانتقِل إلى ملف ZIP الذي يحتوي على إعدادات الخادم الوكيل لواجهة برمجة التطبيقات.
    اسم الخادم الوكيل الاسم المعروض لواجهة برمجة التطبيقات.
  5. راجِع معلومات الإصدار وانقر على إنشاء.
    في حال نجاح هذا الإجراء، يتم عرض رسالة وسيفعِّل Edge تلقائيًا الخادم الوكيل لواجهة برمجة التطبيقات المستورَد في البيئة المحدّدة في مؤسستك. يمكن استدعاء واجهة برمجة التطبيقات التي يعرضها الخادم الوكيل لواجهة برمجة التطبيقات.
  6. انقر على عرض الخادم الوكيل <proxy name> في المحرِّر لعرض صفحة التفاصيل للخادم الوكيل لواجهة برمجة التطبيقات.
  7. لنشر الخادم الوكيل، انقر على القائمة المنسدلة النشر واختَر البيئة التي تريد النشر فيها، ثم استجب للطلب.

إظهار خدمة ويب مستندة إلى SOAP كخادم وكيل لواجهة برمجة التطبيقات

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

إضافة أمان

في صفحة السياسات الشائعة (Edge) أو الأمان (الإصدار الكلاسيكي من Edge) لمعالج إنشاء خادم وكيل، حدد نوع تفويض الأمان الذي تريد إضافته. يلخّص الجدول التالي الخيارات المتاحة:

التفويض الأمني الوصف
مفتاح واجهة برمجة التطبيقات تضيف هذه الإضافة طريقة بسيطة للتحقّق من مفتاح واجهة برمجة التطبيقات إلى الخادم الوكيل لواجهة برمجة التطبيقات الذي تُعرِّفه. استجابةً لذلك، تضيف منصة واجهة برمجة التطبيقات سياسة التحقّق من واجهة برمجة التطبيقات وسياسة AssignMessage إلى الخادم الوكيل لواجهة برمجة التطبيقات. تتحقّق سياسة التحقّق من واجهة برمجة التطبيقات (API) من مفاتيح واجهة برمجة التطبيقات المقدَّمة من خلال طلب التطبيقات. تزيل سياسة AssignMessage مفتاح واجهة برمجة التطبيقات، الذي يتم توفيره في طلب البيانات من واجهة برمجة التطبيقات كمَعلمة طلب بحث، من الطلب الذي تمت إعادة توجيهه إلى خادم الخلفية.
OAuth 2.0 إضافة المصادقة المستندة إلى OAuth 2.0 إلى الخادم الوكيل لواجهة برمجة التطبيقات. يضيف Apigee Edge تلقائيًا سياستين إلى الخادم الوكيل لواجهة برمجة التطبيقات: سياسة للتحقق من رمز الدخول، وسياسة أخرى تقضي بإزالة رمز الدخول من الرسالة قبل إعادة توجيهها إلى الخدمة الخلفية. لمعرفة كيفية الحصول على رمز الدخول، راجِع بروتوكول OAuth.
المرور (بدون إذن) لا يلزم الحصول على تفويض. يتم إرسال الطلبات إلى الخلفية بدون إجراء أي عمليات تحقّق من الأمان في Apigee Edge.

إتاحة سياسة مشاركة الموارد المتعدّدة المصادر (CORS)

إنّ CORS (مشاركة الموارد المتعدّدة المصادر) هي آلية عادية تسمح لمتصفّح الويب بتقديم طلبات مباشرة إلى نطاق آخر. يحدّد معيار CORS مجموعة من عناوين HTTP التي تستخدمها متصفحات الويب والخوادم لتنفيذ الاتصال عبر النطاقات.

يمكنك إضافة دعم CORS إلى واجهة برمجة التطبيقات من خلال اختيار إضافة عناوين CORS في صفحة السياسات الشائعة (Edge) أو الأمان (كلاسيكي Edge) من معالج إنشاء خادم وكيل.

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

استخدام مواصفات OpenAPI لإنشاء خوادم وكيلة

يناقش هذا القسم خيار استخدام OpenAPI المتاح للإنشاء من OpenAPI مواصفات الأنواع التالية من الخوادم الوكيلة لواجهة برمجة التطبيقات: العكسي أو Node.js أو عدم الهدف.

ما هي مواصفات OpenAPI؟

شعار مبادرة Open API"تركّز "مبادرة Open API" (OAI) على إنشاء تنسيق وصف واجهة برمجة تطبيقات محايدة للمورّدين وتطويره وتعزيزه استنادًا إلى مواصفات Swagger". لمزيد من المعلومات حول مبادرة Open API، يُرجى الاطّلاع على https://openapis.org.

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

في ما يلي جزء من مواصفات OpenAPI التي تصف خدمة الهدف التجريبي لخدمة Apigee، http://mocktarget.apigee.net. لمزيد من المعلومات، يُرجى مراجعة https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...

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

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

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

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

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

تحديث التدفقات في خادم وكيل لواجهة برمجة التطبيقات باستخدام مواصفات OpenAPI

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

لتحديث التدفقات في خادم وكيل لواجهة برمجة التطبيقات باستخدام مواصفات OpenAPI:

  1. أضف مسارات الموارد الجديدة إلى مواصفات OpenAPI. راجع تعديل مواصفات OpenAPI الحالية.
  2. افتح الخادم الوكيل لواجهة برمجة التطبيقات في واجهة المستخدم وانقر على علامة التبويب تطوير.
  3. في المستكشف، انقر على + بجوار نقطة نهاية الخادم الوكيل التي تريد تعديلها.
    يتم فتح مربع الحوار "تدفق شرطي جديد".
  4. انقر على من OpenAPI إذا لم يكن هذا الخيار محدّدًا حاليًا.
    إذا كانت هناك موارد في مواصفات OpenAPI لا تحتوي على تدفق شرطي مقابل في الخادم الوكيل لواجهة برمجة التطبيقات، يتم إدراجها في مربّع الحوار، كما هو موضّح في الشكل التالي. الموارد التي لا يتم تمثيلها كتدفقات في الخادم الوكيل الحالي لواجهة برمجة التطبيقات. ويشمل هذا المثال /loveapis و /ip و /json و /xml.
  5. حدد كل مورد تريد إضافة تدفق مشروط له.
  6. انقر على إضافة.

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

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

أنشئ نسخة جديدة من خادم وكيل لواجهة برمجة التطبيقات، كما هو موضح أدناه.

Edge

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

  1. سجِّل الدخول إلى apigee.com/edge.
  2. حدّد التطوير > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل الأيمن.
  3. انقر على الخادم الوكيل لواجهة برمجة التطبيقات في القائمة التي تريد نسخها.
  4. اختَر المشروع > حفظ كنسخة جديدة.

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

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

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث يشير ms-ip إلى عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. حدد واجهات برمجة التطبيقات > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل العلوي.
  3. انقر على الخادم الوكيل لواجهة برمجة التطبيقات في القائمة التي تريد نسخها.
  4. اختَر المشروع > حفظ كنسخة جديدة.

جارٍ نسخ خادم وكيل لواجهة برمجة التطبيقات

انسخ الخادم الوكيل الحالي لواجهة برمجة التطبيقات إلى خادم وكيل جديد لواجهة برمجة التطبيقات، كما هو موضَّح أدناه.

Edge

لنسخ خادم وكيل لواجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge:

  1. سجِّل الدخول إلى apigee.com/edge.
  2. حدّد التطوير > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل الأيمن.
  3. انقر على الخادم الوكيل لواجهة برمجة التطبيقات في القائمة التي تريد نسخها.
  4. اختَر المشروع > حفظ كخادم وكيل جديد لواجهة برمجة التطبيقات.
  5. في مربّع الحوار "حفظ كخادم وكيل جديد"، أدخِل اسم الخادم الوكيل الجديد لواجهة برمجة التطبيقات.
  6. انقر على إضافة.

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

لنسخ خادم وكيل لواجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge الكلاسيكي:

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث يشير ms-ip إلى عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. حدد واجهات برمجة التطبيقات > الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل العلوي.
  3. انقر على الخادم الوكيل لواجهة برمجة التطبيقات في القائمة التي تريد نسخها.
  4. اختَر المشروع > حفظ كخادم وكيل جديد لواجهة برمجة التطبيقات.
  5. في مربّع الحوار "حفظ كخادم وكيل جديد"، أدخِل اسم الخادم الوكيل الجديد لواجهة برمجة التطبيقات.
  6. انقر على إضافة.

الاحتفاظ بنسخة احتياطية من خادم وكيل لواجهة برمجة التطبيقات

يمكنك الاحتفاظ بنسخة احتياطية من خادم وكيل حالي لواجهة برمجة التطبيقات كمجموعة من ملفات XML في حزمة خادم وكيل لواجهة برمجة التطبيقات. بعد التصدير إلى حزمة، يمكنك استيراد الخادم الوكيل لواجهة برمجة التطبيقات إلى خادم وكيل جديد، كما هو موضَّح في مقالة استيراد خادم وكيل لواجهة برمجة التطبيقات من حزمة الخادم الوكيل لواجهة برمجة التطبيقات سابقًا في هذا القسم. لمزيد من المعلومات، يُرجى الاطّلاع على تنزيل الخوادم الوكيلة لواجهة برمجة التطبيقات.

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

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