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

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

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

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

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

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

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

Edge

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

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

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

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

Classic Edge (سحابة خاصة)

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

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

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

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

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

النوع الوصف
الخادم الوكيل العكسي (الأكثر استخدامًا)

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

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

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

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

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

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

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

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

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

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

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

  • عنوان URL لخدمة الخلفية
  • مسار عنوان URL الذي يحدّد بشكل فريد واجهة برمجة التطبيقات التي سيعرِضها الوكيل لواجهة برمجة التطبيقات لأجل التطبيقات المخصّصة

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

Edge

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

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

    ملاحظة: المسار الأساسي لـ API Proxy هو القيمة التلقائية المحدّدة لمحاولة تحويل حقل 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. انقر على تعديل الخادم الوكيل لعرض صفحة التفاصيل للخادم الوكيل لواجهة برمجة التطبيقات.

Classic Edge (سحابة خاصة)

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

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

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

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

    https://[host]/base_path/conditional_flow_path

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

    استخدام عنصر نائب في المسارات الأساسية

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

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

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

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

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

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

Edge

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

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

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

Classic Edge (سحابة خاصة)

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

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

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

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

تعزيز الأمان

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

تفويض الأمان الوصف
مفتاح واجهة برمجة التطبيقات تتم إضافة إثبات الملكية البسيط لمفتاح واجهة برمجة التطبيقات إلى الخادم الوكيل لواجهة برمجة التطبيقات الذي تحدّده. في ردّ على ذلك، تضيف منصة واجهة برمجة التطبيقات سياسة VerifyAPIKey وسياسة AssignMessage إلى الوكيل لواجهة برمجة التطبيقات. تتحقّق سياسة VerifyAPIKey من مفاتيح واجهة برمجة التطبيقات التي تقدّمها التطبيقات التي تطلب البيانات. تزيل سياسة 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، الأنواع التالية من الخوادم الوكيلة لواجهة برمجة التطبيقات: "العكس" أو "عقدة.js" أو "بلا هدف".

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

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

تستخدم مواصفات OpenAPI تنسيقًا عاديًا لوصف واجهة برمجة تطبيقات RESTful. وتكون مواصفات 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. اختَر المشروع > الحفظ كمراجعة جديدة.

Classic Edge (سحابة خاصة)

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

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

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

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

Edge

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

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

Classic Edge (سحابة خاصة)

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

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

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

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

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

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