شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
پیشنیازها
شما به یک حساب کاربری در http://enterprise.apigee.com نیاز دارید. میتوانید برای دریافت یک حساب آزمایشی به آدرس http://accounts.apigee.com/accounts/sign_up مراجعه کنید.
برای استفاده از نمونهها، باید موارد زیر را نیز داشته باشید:
| ابزار | توضیحات |
|---|---|
| گیت | نمونهها در گیتهاب قرار دارند. اگر گیت را نصب ندارید، لطفاً به دستورالعملهای راهاندازی گیت در گیتهاب مراجعه کنید. اگر نمیخواهید گیت را نصب کنید، میتوانید فایلها را مرور کرده و یک فایل زیپ را از https://github.com/apigee/api-platform-samples دانلود کنید. |
| پایتون | پایتون برای اجرای ابزار استقرار Apigee مورد نیاز است. پایتون در اکثر محیطهای لینوکس، در مک با نصب XCode، در دستگاه ویندوز با نصب Cygwin و در بسیاری از مکانهای دیگر وجود دارد. برای دریافت پایتون، لطفاً به صفحه دانلود پایتون مراجعه کنید. |
curl | اسکریپتهای راهاندازی نمونه نیز از curl استفاده میکنند. مطمئن شوید که curl نصب شده و در مسیر شما موجود است (دستور which curl را اجرا کنید تا ببینید آیا در سیستم شما موجود است یا خیر). |
dos2unix | اگر Cygwin را روی ویندوز اجرا میکنید، ممکن است به ابزار dos2unix نیز نیاز داشته باشید. (نصبکننده Cygwin به شما امکان نصب این ابزار را میدهد.) |
نمونهها را دانلود کنید
برای دریافت فایلهای نمونه، از git clone همانطور که در مثال زیر نشان داده شده است استفاده کنید:
git clone https://github.com/apigee/api-platform-samples.git
پروکسیهای API نمونه را وارد و مستقر کنید
نمونهها را از خط فرمان وارد و مستقر کنید:
- پس از دانلود نمونهها، همانطور که در مثال زیر نشان داده شده است، به دایرکتوری
/setupبروید:cd setup
- در دایرکتوری
/setup، فایلsetenv.shرا پیدا کنید. - این فایل را ویرایش کنید تا سازمان خود، آدرس ایمیل مرتبط با نام کاربری خود و محیطی (تولیدی یا آزمایشی) که میخواهید پروکسیهای API را در آن مستقر کنید، تنظیم کنید.
- بعد از ویرایش
setenv.sh، دستور زیر را اجرا کنید:sh deploy_all.sh
این اسکریپت تمام نمونههای پروکسی API را در سازمان شما مستقر میکند. (این فرآیند ۳-۴ دقیقه طول میکشد.) برای استقرار محصولات API، توسعهدهندگان و برنامهها (که برای OAuth استفاده میشوند) دستورالعملها را دنبال کنید.
- پس از اتمام اسکریپت استقرار، به پوشه sample-proxies بروید. در پوشه
sample-proxies، برای هر نمونه پروکسی، یک پوشه پیدا خواهید کرد. در هر پوشه یک فایل README.md با اطلاعاتی در مورد اجرای نمونه و دو اسکریپت وجود دارد که به شما در ایجاد تغییرات کوچک در نمونهها، استقرار و سپس فراخوانی نمونه برای مشاهده تأثیر تغییرات کمک میکنند:-
invoke.sh: این اسکریپت را اجرا کنید تا نسخه پیادهسازیشده پروکسی API را فراخوانی کنید. -
deploy.sh: این اسکریپت را اجرا کنید تا پس از ایجاد هرگونه تغییر، پروکسی API مستقر شود.
-
پروکسیهای API نمونه را فراخوانی کنید
هر پروکسی نمونه دارای یک اسکریپت پوسته مرتبط است که میتواند پس از استقرار پروکسی API، برای فراخوانی آن استفاده شود.
از دایرکتوری /sample-proxies/ proxy_name ، دستور زیر را اجرا کنید:
sh invoke.sh
این، پروکسیای را که در محیط آزمایشی سازمان شما در حال اجرا است، فراخوانی میکند.
عیبیابی
برای اطلاعات عیبیابی، به موارد زیر مراجعه کنید:
پروکسیهای API نمونه را اصلاح و دوباره استفاده کنید
کاربرد معمول پروکسیهای نمونه، تغییر، استقرار و فراخوانی است. این به شما امکان میدهد تغییرات کوچکی ایجاد کنید و سپس ببینید که چه تأثیری بر پیام پاسخ دارند.
برای تغییر یک نمونه پروکسی API برای اشاره به یک سرویس backend متفاوت، فایل پیکربندی XML را در مسیر زیر تغییر دهید:
/apiproxy/targets/target_name.xmlبرای مثال، برای ارجاع نمونه کلید API به سرویس backend خودتان، این فایل را پیدا کنید:
/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>
و سرویس backend شما در 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 به قالبهای پیام خاصی بستگی دارد، بنابراین پروکسیها ممکن است به تغییرات پیکربندی اضافی نیاز داشته باشند.