پراکسی کردن سرویس SOAP

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

آنچه خواهید آموخت

ازطریق این آموزش، با موارد زیر آشنا می‌شوید:

  • از فایل WSDL یک پراکسی Edge API تولید کنید.
  • تفاوت بین نوع پراکسی SOAP با RESTful و پراکسی SOAP عبوری را بدانید.

در این آموزش، یاد می‌گیرید چگونه یک پراکسی Edge API را در مقابل سرویس وب مبتنی بر SOAP قرار دهید.

این آموزش نشان می‌دهد چگونه در مقابل سرویس مبتنی بر SOAP خود، میانای برنامه‌سازی کاربردی RESTful جدیدی تولید کنید. اگرچه در اینجا به‌طور مفصل توضیح داده نشده است، می‌توانید پراکسی عبوری نیز تولید کنید که بار SOAP را می‌پذیرد و آن را به سرویس زیرینه ارسال می‌کند.

آنچه نیاز خواهید داشت

  • حساب Apigee Edge. اگر هنوز حساب ندارید، می‌توانید با دنبال کردن دستورالعمل‌های ایجاد حساب Apigee Edge ثبت‌نام کنید.

درحال ایجاد پراکسی

در اینجا، Edge پراکسی‌ای را تولید می‌کند که در مقابل سرویس SOAP قرار می‌گیرد. دو نوع پراکسی «میانای برنامه‌سازی کاربردی پروتکل دسترسی ساده به شیء» وجود دارد:

  • نوع پراکسی REST-SOAP-REST یک RESTful API جدید با لایه ترجمه به SOAP تولید می‌کند. کارخواه‌ها آن را مانند دیگر سرویس‌های RESTful فرا می‌خوانند و پارامترهای پُرسمان موردنیاز سرویس زیرینه را ارسال می‌کنند. ‫Edge این را به بار داده SOAP ترجمه می‌کند که سرویس انتظار دارد.
  • نوع پراکسی پراکسی عبوری به مشتریان امکان می‌دهد به‌سادگی یک بار اطلاعات SOAP را ارسال کنند. این روشی است که تماس‌های سرویس SOAP از ویژگی‌های مدیریت «لبه» بهره‌مند شوند.

Edge

برای پراکسی کردن سرویس SOAP بااستفاده از «واسط کاربر Edge»:

  1. به سیستم apigee.com/edge وارد شوید.
  2. در نوار پیمایش سمت راست، توسعه > پراکسی‌های API را انتخاب کنید.
  3. روی +پراکسی کلیک کنید.
  4. روی خدمات SOAP کلیک کنید.
  5. در صفحه «جزئیات پراکسی»، موارد زیر را وارد کنید:

    فیلد توضیحات
    منبع WSDL

    انتخاب کنید: نشانی وب

    نشانی وب WSLD زیر را در فیلد Enter URL (نشانی وب را وارد کنید) کپی و جای‌گذاری کنید:

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

    روی اعتبارسنجی کلیک کنید

    ‫Apigee Edge فایل WSDL را دریافت می‌کند و آن را می‌خواند تا فهرست عملیاتی را که سرویس SOAP پشتیبانی می‌کند کشف کند.

    نام

    همین‌طور بماند: delayedstockquote

    این نام برای پراکسی API است که ایجاد می‌کنید.

    مسیر پایه همین‌طور بماند: /delayedstockquote
    شرح به‌صورت اختیاری شرحی اضافه کنید، مثلاً: Stock quote WSDL API Proxy
  6. روی بعدی کلیک کنید.
  7. در صفحه خط‌مشی‌های مشترک، در بخش امنیت: مجوز، گزینه عبور (بدون مجوز) را انتخاب کنید.
  8. روی بعدی کلیک کنید.
  9. در صفحه WSDL operations (عملیات WSDL)، REST to SOAP to REST (از REST به SOAP به REST) را انتخاب کنید.

    پس‌از انتخاب نوع پراکسی، Edge فهرست عملیاتی را که برای آن‌ها مسیرهای REST API تولید می‌کند نمایش می‌دهد. این فهرست به شما امکان می‌دهد از میان عملیات‌های موجود در WSDL انتخاب کنید (درصورتی‌که مجموعه خاصی را مدنظر دارید). توجه داشته باشید که جدول منابعی را که کارخواه REST می‌تواند برای فراخوانی سرویس SOAP زیرینه استفاده کند نیز نمایش می‌دهد.

    همه انتخاب‌های دیگر در صفحه را همان‌گونه که هست بگذارید.

  10. روی بعدی کلیک کنید.
  11. با کلیک کردن روی بعدی، پیش‌فرض‌های «میزبان مجازی» را بپذیرید.
  12. در صفحه خلاصه، در بخش «استقرار اختیاری» روی آزمایش و سپس روی ایجاد و استقرار کلیک کنید.

    ‫Edge کارگزار نیابتی RESTful API را تولید می‌کند و آن را در محیط test مستقر می‌کند. از WSDL، عملیات پشتیبانی‌شده سرویس، پارامترهای ورودی، و غیره را تعیین می‌کند. ‫Edge روش HTTP را برای استفاده در هر عملیاتی پیشنهاد می‌دهد. معمولاً Edge عملیات را به درخواست‌های GET ترجمه می‌کند که مزیت قابل ذخیره شدن در حافظه نهان را دارند. ‫Edge همچنین نقطه پایانی هدف زیرینه را راه‌اندازی می‌کند که می‌تواند برای هر عملیات SOAP متفاوت باشد.

    مگر اینکه درحال سفارشی‌سازی کردن پراکسی جدید API باشید (که در این آموزش گام‌به‌گام این کار را نمی‌کنید)، این تمام کاری است که باید انجام دهید. می‌توانید به آزمایش کارگزار نیابتی جدید API بروید.

Classic Edge (ابر خصوصی)

برای پراکسی کردن سرویس SOAP بااستفاده از «واسط کاربر Classic Edge»:

  1. به سیستم http://ms-ip:9000 وارد شوید، که در آن ms-ip نشانی IP یا نام ساناد گره «سرور مدیریت» است.
  2. در نوار پیمایش بالا، میاناهای برنامه‌سازی کاربردی > پراکسی‌های میانای برنامه‌سازی کاربردی را انتخاب کنید.
  3. روی + پراکسی API کلیک کنید.
  4. روی خدمات SOAP کلیک کنید.
  5. در صفحه «جزئیات پراکسی»، موارد زیر را وارد کنید:

    فیلد توضیحات
    WSDL

    انتخاب کنید: نشانی وب نمونه

    سپس انتخاب کنید:
    ...delayedstockquote.asmx?WSDL

    روی اعتبارسنجی کلیک کنید

    ‫Apigee Edge فایل WSDL را دریافت می‌کند و آن را می‌خواند تا فهرست عملیاتی را که سرویس SOAP پشتیبانی می‌کند کشف کند.

    نام پراکسی

    وارد کنید: delayedstockquote

    این نام پراکسی‌ای است که ایجاد می‌کنید.

    مسیر پایه پراکسی و شرح همان‌طور که هست بماند.
  6. روی بعدی کلیک کنید.
  7. در صفحه WSDL، این انتخاب‌ها را انجام دهید:
    در این فیلد این کار را انجام دهید
    نوع پراکسی API

    انتخاب کنید: REST به SOAP به REST

    پس‌از انتخاب نوع پراکسی، Edge فهرست عملیاتی را که برای آن‌ها مسیرهای REST API تولید می‌کند نمایش می‌دهد، همان‌طور که در اینجا نشان داده شده است. این فهرست به شما امکان می‌دهد از بین عملیات‌های موجود در WSDL انتخاب کنید (درصورتی‌که مجموعه خاصی را مدنظر دارید). توجه داشته باشید که جدول منابعی را که کارخواه REST می‌تواند برای فراخوانی سرویس SOAP زیرینه استفاده کند نیز نمایش می‌دهد.

    فعلاً مجموعه اول عملیات را انتخاب‌شده باقی بگذارید.

    نوع درگاه: DelayedStockQuoteSoap هر سه عملیات WSDL را انتخاب کنید. سایر تنظیمات را به همان صورت باقی بگذارید.

  8. روی بعدی کلیک کنید.
  9. در صفحه «امنیت»، عبور (هیچ‌کدام) را انتخاب کنید.
  10. روی بعدی کلیک کنید.
  11. پیش‌فرض‌های «میزبان مجازی» را بپذیرید و روی بعدی کلیک کنید.
  12. در صفحه «ساخت»، پیش‌فرض‌ها را بپذیرید و روی ساختن و استقرار کلیک کنید تا Edge شروع به تولید پراکسی کند.

    ‫Edge پراکسی RESTful API تولید می‌کند. از 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 استفاده می‌کنید، فرمانی مثل این اجرا می‌کنید:

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

اگر GOOG را برای پارامتر پُرسمان StockSymbol وارد کرده باشید، باید قیمت فعلی سهام «شرکت Alphabet» کلاس 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 به SOAP به REST» پراکسی می‌کنید، Edge به‌طور خودکار مشخصات OpenAPI تولید می‌کند. می‌توانید از OpenAPI Spec برای تولید مستندات API برای API استفاده کنید.

برای دریافت «مشخصات OpenAPI»، کافی است به این نشانی وب بروید:

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

امتیاز اضافی: چگونه متوجه می‌شوید که از کدام منبع، فعل، و پارامترهای پُرسمان استفاده کنید؟

در فراخوانی API آزمایشی، از منبع و پارامترهای پُرسمان خاصی در فراخوانی cURL خود برای سرویس زیرینه SOAP استفاده کردید. اما چطور می‌توانید خودتان این را بفهمید؟

منبع و فعل

در جادوگر پراکسی API هنگام ایجاد پراکسی، دیدید که چگونه عملیات SOAP به فعل‌ها و منابع API نگاشت می‌شوند. اما اگر آن‌ها را یادداشت نکرده‌اید، در اینجا نحوه اطلاع از آن‌ها پس‌از ایجاد پراکسی آورده شده است.

در زبانه توسعه میانای برنامه‌سازی کاربردی، در قاب «پیمایشگر» در سمت راست، فهرستی از جاری‌سازی‌ها را در بخش «نقطه‌های پایان پراکسی» خواهید دید. روی جریانی که به آن علاقه دارید کلیک کنید. برای مثال، جریان GetQuote گزینه خوبی است. سپس XML را در قاب «کد» مشاهده کنید، که مسیر منبع و فعل جریان را در عنصر <Condition> نشان می‌دهد: /quote و GET.

پارامترهای پُرسمان

با انتخاب جریان GetQuote، روی اولین خط‌مشی در نمای جریان گرافیکی کلیک کنید. باید خط‌مشی «استخراج متغیرها» باشد که پارامترهای پُرسمانی را که انتظار می‌رود گذرانده شوند ضبط کند: StockSymbol و LicenseKey. (اگر جستجوی وبی برای سرویس SOAP انجام دهید، به شما می‌گوید که چه چیزی را برای LicenseKey ارسال کنید.)

پارامترهای پُرسمان ضبط‌شده به‌عنوان متغیر ذخیره می‌شوند و خط‌مشی بعدی از آن‌ها برای ساختن پیام SOAP استفاده می‌کند.