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

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

المتطلبات الأساسية

ستحتاج إلى حساب على http://enterprise.apigee.com. يمكنك الاشتراك للحصول على حساب تجريبي على http://accounts.apigee.com/accounts/sign_up.

لاستخدام النماذج، يجب أن يتوفّر لديك أيضًا ما يلي:

الأداة الوصف
Git توجد العينات على GitHub. إذا لم يسبق لك تثبيت Git، يُرجى الاطّلاع على تعليمات إعداد GitHub. إذا كنت لا تريد تثبيت Git، يمكنك تصفّح الملفات وتنزيل ملف ZIP من https://github.com/apigee/api-platform-samples.
Python

تكون لغة بايثون مطلوبة لتشغيل أداة نشر Apigee. تتوفّر لغة Python في معظم بيئات Linux، وعلى جهاز Mac تم تثبيت XCode عليه، وعلى جهاز Windows تم تثبيت Cygwin عليه، وفي العديد من الأماكن الأخرى.

للحصول على لغة Python، يُرجى الرجوع إلى صفحة تنزيل Python.

curl تستخدِم نماذج النصوص البرمجية للإعداد أيضًا السمة curl. تأكَّد من تثبيت curl ومن أنّه متاح في مسارك (يمكنك تشغيل الأمر which curl لمعرفة ما إذا كان متوفرًا على نظامك).
dos2unix إذا كنت تشغّل Cygwin على نظام التشغيل Windows، قد تحتاج أيضًا إلى الأداة المساعدة dos2unix. (يتيح لك مثبت Cygwin تثبيت الأداة المساعدة).

تنزيل النماذج

وللحصول على نماذج الملفات، استخدِم git clone كما يبيِّن المثال التالي:

git clone https://github.com/apigee/api-platform-samples.git

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

استيراد النماذج ونشرها من سطر الأوامر:

  1. بعد تنزيل النماذج، انتقِل إلى الدليل /setup، على النحو الموضّح في المثال التالي:
    cd setup
  2. في دليل /setup، حدِّد موقع الملف setenv.sh.
  3. يمكنك تعديل هذا الملف لإعداد مؤسستك وعنوان البريد الإلكتروني المرتبط باسم المستخدم والبيئة (الإنتاج أو الاختبار) التي تريد نشر الخوادم الوكيلة لواجهة برمجة التطبيقات فيها.
  4. بعد تعديل setenv.sh، نفِّذ ما يلي:
    sh deploy_all.sh

    ينشر هذا النص البرمجي جميع نماذج الخادم الوكيل لواجهة برمجة التطبيقات في مؤسستك. (تستغرق العملية من 3 إلى 4 دقائق). اتّبِع التعليمات لنشر منتجات واجهة برمجة التطبيقات ومطوّري البرامج والتطبيقات (المستخدَمة في OAuth).

  5. بعد اكتمال نشر النص البرمجي، انتقل إلى دليل نماذج الخوادم الوكيلة. في الدليل sample-proxies، يمكنك العثور على دليل واحد لكل نموذج خادم وكيل. يتضمّن كل دليل ملف README.md يحتوي على معلومات حول تشغيل النموذج، ونصَّين برمجيَين يساعدك في إجراء تغييرات بسيطة على العيّنات ونشرها ثم استدعاءها لمعرفة التأثير الذي أحدثته:
    • invoke.sh: يمكنك تنفيذ هذا النص البرمجي لاستدعاء الإصدار المنشور من الخادم الوكيل لواجهة برمجة التطبيقات.
    • deploy.sh: نفِّذ هذا النص البرمجي لنشر الخادم الوكيل لواجهة برمجة التطبيقات بعد إجراء أي تغييرات.

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

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

من الدليل /sample-proxies/proxy_name، نفِّذ ما يلي:

sh invoke.sh

ويستدعي هذا الخادم الوكيل قيد التشغيل في بيئة الاختبار في مؤسستك.

تحديد المشاكل وحلّها

للحصول على معلومات حول تحديد المشاكل وحلّها، اطّلِع على ما يلي:

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

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

لتعديل نموذج خادم وكيل لواجهة برمجة التطبيقات بحيث يشير إلى خدمة خلفية مختلفة، عدِّل ملف إعداد XML في الموقع التالي:

/apiproxy/targets/target_name.xml

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

/apikey/apiproxy/targets/default.xml

إذا كانت الإعدادات التلقائية تشير إلى http://mocktarget.apigee.net، مثلاً:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

وتتوفر خدمة الخلفية على http://api.myproject.com/، يمكنك تعديل الإعدادات لتبدو كما يلي:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

بعد حفظ التغييرات، انشر الخادم الوكيل لواجهة برمجة التطبيقات كما يبيّن المثال التالي:

sh deploy.sh

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