إنشاء خادم وكيل SOAP

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

المعلومات التي ستطّلع عليها

من خلال هذا البرنامج التعليمي، ستتعلّم ما يلي:

  • إنشاء خادم وكيل لواجهة برمجة تطبيقات Edge من ملف WSDL
  • تعرّف على الفرق بين نوع الخادم الوكيل RESTful SOAP والخادم الوكيل لبروتوكول SOAP.

ستتعرف في هذا البرنامج التعليمي على طريقة وضع خادم وكيل Edge API أمام خدمة ويب مستندة إلى SOAP.

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

المتطلبات

  • حساب Apigee Edge. إذا لم يكن لديك حساب بعد، يمكنك الاشتراك باستخدام التوجيهات في إنشاء حساب Apigee Edge.

إنشاء الخادم الوكيل

هنا، ستجعل Edge ينشئ الخادم الوكيل الذي سيكون أمام خدمة SOAP. هناك نوعان من الخوادم الوكيلة لواجهة برمجة تطبيقات SOAP:

  • ينشئ نوع الخادم الوكيل REST-SOAP-REST واجهة برمجة تطبيقات RESTful جديدة تتضمّن طبقة ترجمة إلى SOAP. ويطلق عليه العملاء اسم خدمات RESTful الأخرى، مع تمرير معلَمات طلب البحث التي تحتاج إليها الخدمة الخلفية. يحوّل Edge هذا إلى حمولة SOAP المتوقعة من خلال الخدمة.
  • يتيح نوع الخادم الوكيل للتمرير الوكيل للعملاء إمكانية تمرير حمولة بيانات SOAP ببساطة. وهذه طريقة لكي تستفيد مكالمات خدمة SOAP من ميزات إدارة Edge.

Edge

لتعيين خادم وكيل لخدمة SOAP باستخدام واجهة مستخدم Edge:

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

    الحقل الوصف
    مصدر WSDL

    اختيار: عنوان URL

    انسخ عنوان URL التالي لـ WSLD في حقل إدخال عنوان URL:

    https://ws.cdyne.com/delayedstockquote/delayedstockquote.asmx?wsdl

    النقر: التحقّق من الصحة

    يحصل Apigee Edge على ملف WSDL ويقرأه لاستكشاف قائمة العمليات التي تتيحها خدمة SOAP.

    الاسم

    عدم تغيير الإعدادات الحالية: delayedstockquote

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

    المسار الأساسي عدم تغيير الإعدادات الحالية: /delayedstockquote
    الوصف يمكنك إضافة وصف، مثل: خادم وكيل واجهة برمجة تطبيقات عرض أسعار الأسهم في WSDL
  6. انقر على التالي.
  7. في صفحة السياسات الشائعة، ضمن الأمان: التفويض، اختَر اجتياز (بدون تفويض).
  8. انقر على التالي.
  9. في صفحة عمليات بروتوكول Workspace (WSDL)، اختَر: REST to SOAP to REST.

    بعد اختيار نوع الخادم الوكيل، يعرض Edge قائمة العمليات التي سينشئ لها مسارات واجهة برمجة تطبيقات REST. وتتيح لك هذه القائمة الاختيار من بين العمليات المتوفّرة في WSDL (في حال كانت لديك مجموعة معيّنة تبحث عنها). لاحظ أن الجدول يعرض أيضًا الموارد التي يمكن لعميل REST استخدامها لاستدعاء خدمة SOAP للخلفية.

    اترك جميع الاختيارات الأخرى في الصفحة كما هي.

  10. انقر على التالي.
  11. اقبل الإعدادات التلقائية للمضيف الافتراضي بالنقر على التالي.
  12. في صفحة الملخّص، ضمن "النشر الاختياري"، انقر على اختبار، ثم انقر على إنشاء ونشر.

    ينشئ Edge الخادم الوكيل لواجهة برمجة التطبيقات RESTful وينشره في بيئة test. يحدّد WSDL العمليات المتوافقة للخدمة ومعلَمات الإدخال وما إلى ذلك، وذلك استنادًا إلى WSDL. يقترح Edge طريقة HTTP التي يجب استخدامها لكل عملية. يحوّل Edge عادةً العمليات إلى طلبات GET، وهي ميزة كونها قابلة للتخزين المؤقت. يقوم Edge أيضًا بإعداد نقطة النهاية المستهدفة للخلفية، والتي يمكن أن تختلف حسب عملية SOAP.

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

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

لتعيين خادم وكيل لخدمة SOAP باستخدام واجهة مستخدم Edge الكلاسيكية:

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

    الحقل الوصف
    WSDL

    اختَر: مثال على عنوان URL.

    بعد ذلك، اختَر:
    ...delayedstockquote.asmx?WSDL

    النقر: التحقّق من الصحة

    يحصل Apigee Edge على ملف WSDL ويقرأه لاستكشاف قائمة العمليات التي تتيحها خدمة SOAP.

    اسم الخادم الوكيل

    إدخال: delayedstockquote

    هذا اسم للخادم الوكيل الذي تُنشئه.

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

    اختر: REST إلى SOAP to REST

    بعد اختيار نوع الخادم الوكيل، يعرض Edge قائمة العمليات التي سينشئ لها مسارات واجهة برمجة تطبيقات REST، كما هو موضّح هنا. تمنحك هذه القائمة فرصة للاختيار من بين العمليات المتوفّرة في WSDL (في حال كانت لديك مجموعة معيّنة تبحث عنها). لاحظ أن الجدول يعرض أيضًا الموارد التي يمكن لعميل REST استخدامها لاستدعاء خدمة SOAP للخلفية.

    في الوقت الحالي، ما عليك سوى ترك المجموعة الأولى من العمليات محددة.

    نوع المنفذ: DelayedStockعلّقSoap اختَر جميع عمليات WSDL الثلاث. واترك الإعدادات الأخرى كما هي.

  8. انقر على التالي.
  9. في صفحة "الأمان"، اختَر تمرير (بدون).
  10. انقر على التالي.
  11. اقبل الإعدادات التلقائية للمضيف الافتراضي، وانقر على التالي.
  12. في صفحة الإصدار، وافِق على الإعدادات التلقائية، ثم انقر على إنشاء ونشر حتى يبدأ Edge في إنشاء الخادم الوكيل.

    ينشئ Edge خادمًا وكيلاً لواجهة برمجة التطبيقات RESTful. يحدّد WSDL العمليات المتوافقة للخدمة ومعلَمات الإدخال وما إلى ذلك، وذلك استنادًا إلى WSDL. يقترح Edge طريقة HTTP التي يجب استخدامها لكل عملية. يحوّل Edge عادةً العمليات إلى طلبات GET، وهي ميزة كونها قابلة للتخزين المؤقت. يقوم Edge أيضًا بإعداد نقطة النهاية المستهدفة للخلفية، والتي يمكن أن تختلف حسب عملية SOAP.

    ما لم تكن تكفي تخصيص الخادم الوكيل الجديد (ولم تكن في هذا الدليل التوجيهي)، فالأمر لا يقتصر على ذلك. يمكنك الانتقال إلى اختبار الخادم الوكيل الجديد.

اختبار الخادم الوكيل

لتجربة الخادم الوكيل الذي أنشأته، افتح موجّه الأوامر واستخدِم cURL. اكتب الأمر أدناه، حيث:

  • ORG هو اسم مؤسسة Edge التي أنشأت فيها الخادم الوكيل.
  • ENV هو البيئة التي يتم نشر الخادم الوكيل إليها.
  • يتوافق النطاق مع مثيل Edge الذي تستخدمه.
curl "https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

على سبيل المثال، إذا كانت مؤسستك هي docfood والبيئة هي test، وكنت تستخدم Edge Enterprise Cloud، يمكنك تنفيذ أمر على النحو التالي:

curl "https://docfood-test.apigee.net/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

إذا أدخلت GOOG لمَعلمة طلب البحث StockSymbol، من المفترَض أن تحصل على السعر الحالي لسهم Alphabet Inc. من الفئة C. مثال:

{  
   "GetQuoteResponse":{  
      "GetQuoteResult":{  
         "StockSymbol":"GOOG",
         "LastTradeAmount":819.55,
         "LastTradeDateTime":"2017-02-13T14:33:00",
         "StockChange":5.88,
         "OpenAmount":816.0,
         "DayHigh":820.96,
         "DayLow":815.49,
         "StockVolume":785064,
         "PrevCls":813.67,
         "ChangePercent":"+0.72%",
         "FiftyTwoWeekRange":"663.28 - 841.95",
         "EarnPerShare":27.88,
         "PE":29.4,
         "CompanyName":"Alphabet Inc.",
         "QuoteError":false
      }
   }
}

الحصول على مواصفات OpenAPI التي يتم إنشاؤها تلقائيًا

عند إنشاء وكيل لخدمة SOAP باستخدام "REST to SOAP to REST"، يُنشئ Edge تلقائيًا مواصفات OpenAPI. يمكنك استخدام مواصفات OpenAPI لإنشاء مستندات حول واجهة برمجة التطبيقات.

للحصول على مواصفات OpenAPI، ما عليك سوى زيارة عنوان URL التالي:

curl https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/openapi.json

الرصيد الإضافي: كيف يمكنك معرفة المصدر والفعل ومعلَمات طلب البحث التي يجب استخدامها؟

في طلب اختبار واجهة برمجة التطبيقات، استخدمت معلَمات طلب بحث ومورد معيّن في استدعاء cURL لخدمة SOAP الخلفية. ولكن كيف ستكتشف ذلك بنفسك؟

المورد والفعل

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

في علامة التبويب تطوير في الخادم الوكيل لواجهة برمجة التطبيقات، في لوحة المستكشف على يمين الصفحة، ستظهر لك قائمة بالتدفقات ضمن نقاط نهاية الخادم الوكيل. انقر على التدفق الذي يهمّك. على سبيل المثال، يُعدّ مسار GetQuote مناسبًا. بعد ذلك، اعرض ملف XML في جزء "الرمز" الذي يعرض مسار المورد والفعل للتدفق في العنصر <Condition>: /quote وGET.

معلمات طلب البحث

من خلال اختيار مسار GetQuote، انقر على السياسة الأولى في طريقة عرض التدفق الرسومي. ويجب أن تكون هذه السياسة سياسة استخراج المتغيّرات التي تسجِّل مَعلمات طلب البحث التي يُتوقع تمريرها: StockSymbol وLicenseKey. (إذا أجريت بحثًا على الويب عن خدمة SOAP، ستوضّح لك هذه الخدمة ما يجب تمريره لمفتاح الترخيص).

يتم حفظ مَعلمات طلب البحث التي تم التقاطها كمتغيّرات، ويتم استخدامها بواسطة السياسة التالية لإنشاء رسالة SOAP.