استفاده از پراکسی‌های API نمونه

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

پیش‌نیازها

در http://enterprise.apigee.com به حساب نیاز دارید. می‌توانید در http://accounts.apigee.com/accounts/sign_up برای حساب آزمایشی ثبت‌نام کنید.

برای استفاده از نمونه‌ها، باید موارد زیر را نیز داشته باشید:

ابزار شرح
Git نمونه‌ها در GitHub قرار دارند. اگر Git را نصب نکرده‌اید، لطفاً به دستورالعمل‌های راه‌اندازی Git در GitHub مراجعه کنید. اگر نمی‌خواهید Git را نصب کنید، می‌توانید فایل‌ها را مرور کنید و ZIP را از https://github.com/apigee/api-platform-samples بارگیری کنید.
Python

برای اجرای ابزار استقرار Apigee به Python نیاز است. ‫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. این فایل را ویرایش کنید تا سازمان، نشانی ایمیل مرتبط با نام کاربری، و محیط (تولید یا آزمایش) را که می‌خواهید کارگزاران نیابتی API را در آنجا مستقر کنید تنظیم کنید.
  4. پس‌از ویرایش setenv.sh، موارد زیر را اجرا کنید:
    sh deploy_all.sh

    این نوشتار همه نمونه‌های کارگزار نیابتی API را در سازمانتان مستقر می‌کند. (این فرایند ۳ تا ۴ دقیقه طول می‌کشد.) پیام‌واره‌ها را برای پیاده‌سازی محصولات میانای برنامه‌سازی کاربردی، توسعه‌دهندگان، و برنامه‌ها (که برای OAuth استفاده می‌شوند) دنبال کنید.

  5. پس‌از تکمیل شدن نوشتار استقرار، به فهرست راهنمای نمونه-پروکسی‌ها پیمایش کنید. در راهنمای sample-proxies، برای هر نمونه کارگزار یک راهنما پیدا خواهید کرد. در هر دایرکتوری، فایل README.md با اطلاعاتی درباره اجرای نمونه و دو دستورگان وجود دارد که به شما کمک می‌کند تا تغییرات کوچکی در نمونه‌ها ایجاد کنید، آن‌ها را مستقر کنید، و سپس نمونه را فراخوانی کنید تا ببینید تغییر شما چه تأثیری داشته است:
    • invoke.sh: برای فراخواندن نسخه مستقرشده میانای برنامه‌سازی کاربردی پروکسی، این دستورگان را اجرا کنید.
    • deploy.sh: پس‌از ایجاد هرگونه تغییر، این دستورگان را اجرا کنید تا میانای برنامه‌سازی کاربر را مستقر کنید.

فراخوانی کردن پراکسی‌های میانای برنامه‌سازی کاربردی نمونه

هر پراکسی نمونه دارای یک دستور پوسته مرتبط است که می‌توان از آن برای فراخوانی پراکسی API پس‌از استقرار آن استفاده کرد.

از فهرست راهنمای /sample-proxies/proxy_name، موارد زیر را اجرا کنید:

sh invoke.sh

این کار کارگزار وکیلی را که در محیط آزمایش در سازمان شما اجرا می‌شود فرا می‌خواند.

عیب‌یابی

برای کسب اطلاعات عیب‌یابی، موارد زیر را ببینید:

تغییر دادن و استفاده مجدد از پراکسی‌های میانای برنامه‌سازی کاربردی نمونه

استفاده معمول از پراکسی‌های نمونه برای اصلاح، استقرار، و فراخوانی است. این کار به شما امکان می‌دهد تغییرات کوچکی ایجاد کنید و سپس ببینید چه تأثیری بر پیام پاسخ دارد.

برای اصلاح یک نمونه کارگزار API به‌طوری‌که به سرویس زمینه‌ای دیگری اشاره کند، فایل پیکربندی XML را در مکان زیر اصلاح کنید:

/apiproxy/targets/target_name.xml

برای مثال، برای اشاره نمونه کلید API به سرویس زیرینه خودتان، این فایل را پیدا کنید:

/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>

پس‌از ذخیره کردن تغییرات، پراکسی API را همان‌طور که در مثال زیر نشان داده شده است مستقر کنید:

sh deploy.sh

کارگزاران دیگر API را می‌توان به همین روش تغییر داد تا از عملکرد کارگزار API دربرابر خدمات هدف موجود استفاده شود. بااین‌حال، در برخی موارد، رفتار پراکسی API به قالب‌های پیام خاصی وابسته است، بنابراین ممکن است پراکسی‌ها به تغییرات پیکربندی اضافی نیاز داشته باشند.