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

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

پیش نیازها

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

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

نمونه ها را دانلود کنید

برای به دست آوردن فایل های نمونه، همانطور که در مثال زیر نشان می دهد، از git clone استفاده کنید:

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

نمونه پروکسی های API را وارد و مستقر کنید

نمونه ها را از خط فرمان وارد و مستقر کنید:

1. پس از دانلود نمونه ها، همانطور که در مثال زیر نشان می دهد، به پوشه /setup بروید:

   cd setup

2. در پوشه /setup ، فایل setenv.sh را پیدا کنید.
3. این فایل را ویرایش کنید تا سازمان خود، آدرس ایمیل مرتبط با نام کاربری و محیطی که می‌خواهید پراکسی‌های API را در آن مستقر کنید (تحریک یا آزمایش) تنظیم کنید.
4. پس از ویرایش setenv.sh ، موارد زیر را اجرا کنید:

   sh deploy_all.sh

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

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

نمونه پراکسی های API را فراخوانی کنید

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

از پوشه /sample-proxies/ proxy_name ، موارد زیر را اجرا کنید:

sh invoke.sh

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

عیب یابی

برای اطلاعات عیب یابی به موارد زیر مراجعه کنید:

• معرفی عیب یابی
• عیب یابی Windows/Cygwin

پروکسی های نمونه API را تغییر داده و مجدداً استفاده کنید

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

برای تغییر یک نمونه پراکسی 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 به قالب‌های پیام خاصی بستگی دارد، بنابراین ممکن است پراکسی‌ها به تغییرات پیکربندی اضافی نیاز داشته باشند.