ابزارهای برنامه نویسی

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

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

استفاده از میانای کاربر Edge

«میانای کاربری Apigee Edge» ابزاری مبتنی بر مرورگر است که می‌توانید از آن برای ایجاد، پیکربندی، و مدیریت کارگزاران API و محصولات API استفاده کنید. زیرمجموعه‌ای از وظایف را فقط بااستفاده از API نیز می‌توان انجام داد.

جدول زیر نحوه دسترسی به «واسط کاربر Edge» را شرح می‌دهد:

محصول نام میانای کاربر نشانی وب دسترسی
Edge میانای کاربر Edge

برای دسترسی به «میانای کاربری Edge»، از نشانی وب زیر استفاده کنید:

https://apigee.com/edge

برای آموزش استفاده از Edge UI، به ساخت اولین پراکسی API مراجعه کنید.

‫Edge برای فضای ابری خصوصی  میانای کاربر کلاسیک Edge

برای دسترسی به «میانای کاربری Edge» برای Edge for Private Cloud، از نشانی وب زیر استفاده کنید:

http://ms-ip:9000

که در آن ms-ip نشانی IP یا نام ساناد گره «سرور مدیریت» است.

بااستفاده از «میانای کاربری Edge»، می‌توانید:

  • با ویرایش کد و ردیابی جریان‌های درخواست ازطریق پراکسی‌هایتان، پراکسی‌های API ایجاد کنید.
  • محصولات API بسازید که کارگزارها را برای نمایش درخواست‌های مشتری دسته‌بندی می‌کند.
  • توسعه‌دهندگان و برنامه‌های توسعه‌دهنده را مدیریت کنید.
  • محیط‌های آزمایش و تولید را پیکربندی کنید.
  • برنامه‌های جاوا اسکریپت و Node.js را پیاده‌سازی کنید.

تصویر زیر ویرایشگر پراکسی API را در رابط کاربری نشان می‌دهد که می‌توانید از آن برای ایجاد و پیکربندی پراکسی API استفاده کنید:

برگه «توسعه» را که در ویرایشگر پراکسی API در «واسط کاربر Edge» انتخاب شده است نشان می‌دهد.

استفاده از Edge API

می‌توانید از Edge API برای مدیریت منابع API خود استفاده کنید. این APIها همچنین دسترسی به قابلیت‌های سطح پایین را که توسط واسط کاربر آشکار نشده‌اند فراهم می‌کنند.

نقطه‌های پایانی API اغلب داده‌هایی را که حاوی اطلاعات پیکربندی است دریافت می‌کنند و برای دسترسی به آن‌ها باید اطلاعات اصالت‌سنجی، مثل نام کاربری و گذرواژه، را ارسال کنید. با پیروی از اصول RESTful، می‌توانید متدهای HTTP GET، POST، PUT، و DELETE را در هریک از منابع API فراخوانی کنید.

برای فهرست کامل «میاناهای برنامه‌سازی کاربردی Apigee Edge»، مرجع میانای برنامه‌سازی کاربردی Apigee Edge را ببینید.

آشنایی با مسیر پایه Edge API

مسیری که در درخواست‌های «میانای برنامه‌سازی کاربردی» استفاده می‌کنید موارد زیر را به‌هم متصل می‌کند:

  • مسیر پایه که شامل نام سازمان شما است. برای مثال: https://api.enterprise.apigee.com/v1/organizations/org_name
  • نقطه پایانی که به منبع Edge که به آن دسترسی دارید اشاره می‌کند.

برای مثال، اگر نام سازمان شما apibuilders است، هر تماسی که با «میانای برنامه‌سازی کاربردی» برقرار می‌کنید از مسیر پایه زیر استفاده خواهد کرد:

https://api.enterprise.apigee.com/v1/organizations/apibuilders

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

https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis

بسیاری از منابع براساس محیط محدود می‌شوند. به‌طور پیش‌فرض دو محیط ارائه می‌شود: آزمایشی و تولید. برای مثال، حافظه‌های نهان براساس محیط محدود می‌شوند. یک حافظه نهان مشترک به‌نام «mycache» به‌طور پیش‌فرض در هر محیطی گنجانده می‌شود.

می‌توانید حافظه‌های نهان را با فراخوانی GET در منبع حافظه نهان به‌صورت زیر فهرست کنید:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches

اصالت‌سنجی دسترسی

هنگام فراخوانی APIها، باید هویت خود را در سرور API اصالت‌سنجی کنید. می‌توانید این کار را به یکی از روش‌های زیر انجام دهید:

علاوه‌براین، Apigee توصیه می‌کند که از اصالت‌سنجی دوعاملی استفاده کنید، همان‌طور که در فعال کردن اصالت‌سنجی دوعاملی برای حساب Apigee توضیح داده شده است.

محدودیت‌های «میانای برنامه‌سازی کاربردی Edge»

هر سازمان به نرخ‌های تماس Edge API زیر محدود می‌شود:

  • ‫۱۰٬۰۰۰ تماس در دقیقه برای سازمان‌های دارای طرح‌های پولی
  • ‫۶۰۰ تماس در دقیقه برای سازمان‌های آزمایشی

کدهای وضعیت HTTP 401 و 403 در این محدودیت محاسبه نمی‌شوند. هر تماسی که از این محدودیت‌ها فراتر رود، کد وضعیت 429 Too Many Requests را برمی‌گرداند.

نکته‌هایی برای کار با Edge APIs

این بخش برخی‌از تکنیک‌هایی را که کار با «میاناهای برنامه‌سازی کاربردی Edge» را آسان‌تر می‌کند توضیح می‌دهد.

کوته‌نویسی نشانی‌های وب درخواست

وقتی نشانی وب درخواست خود را برای «میاناهای برنامه‌سازی کاربردی Edge» می‌سازید، می‌توانید از مخفف‌های زیر استفاده کنید:

  • /e = /environments
  • /o = /organizations
  • /r = /revisions

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

برای مثال:

THIS:
https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments
CAN BE MUCH SHORTER:
https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments

اجرای فرمان‌های curl

برای ارسال درخواست به API، از کارخواه HTTP استفاده کنید. بسیاری از مثال‌های موجود در مستندات درخواست‌های نمونه API را بااستفاده از curl، یک کارخواه HTTP پرکاربرد، ارائه می‌دهند. اگر نیاز دارید curl را نصب کنید، می‌توانید آن را از http://curl.haxx.se بارگیری کنید.

تماس‌های میانای برنامه‌سازی کاربردی از فشرده‌سازی gzip در پاسخ‌ها پشتیبانی می‌کند. اگر 'Accept-Encoding: gzip, deflate' را در فراخوانی‌های API خود تنظیم کنید، هر پاسخی بزرگ‌تر از ۱۰۲۴ بایت در قالب gzip برگردانده می‌شود.

قالب‌بندی درخواست‌ها و پاسخ‌های XML و JSON

«میانای برنامه‌سازی کاربردی Edge» به‌طور پیش‌فرض داده‌ها را به‌صورت JSON برمی‌گرداند. برای بسیاری از درخواست‌ها، می‌توانید پاسخ را به‌جای آن به‌صورت XML دریافت کنید. برای انجام این کار، سرصفحه درخواست Accept را روی application/xml تنظیم کنید، همان‌طور که در مثال زیر نشان داده شده است:

curl -H "Authorization: Bearer `get_token`" \
  -H "Accept: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  | xmllint --format -

پاسخ باید به‌صورت زیر باشد:

<List>
  <Item>SOAP-Message-Validation-1</Item>
  <Item>Spike-Arrest-1</Item>
  <Item>XML-to-JSON-1</Item>
</List>

توجه داشته باشید که این مثال از prettyprint برای نمایش نتایج با انتقال پاسخ ازطریق xmllint استفاده می‌کند.

برنامه کمکی acurl از سرصفحه Accept پشتیبانی نمی‌کند. درنتیجه، فقط می‌توانید پاسخ‌های قالب‌بندی‌شده JSON را با acurl دریافت کنید.

برای استفاده از prettyprint برای پاسخ JSON، می‌توانید از کتابخانه json.tool Python استفاده کنید:

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer `get_token`" \
  | python -m json.tool

در زیر نمونه‌ای از پاسخ ارائه شده است:

[
  "SOAP-Message-Validation-1",
  "Spike-Arrest-1",
  "XML-to-JSON-1"
]

برای «زبان نشانه‌گذاری توسعه‌پذیر»، می‌توانید از xmllint استفاده کنید:

curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -

هنگام ارسال یا قرار دادن بار در XML، از سرصفحه Content-type HTTP استفاده کنید:

acurl -H "Content-type:text/xml" -X POST -d \
'<XMLPayload>
 </XMLPayload> ' \
https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address

محیط‌های استقرار

هر سازمانی که به‌طور پیش‌فرض از Apigee Edge استفاده می‌کند، حداقل دو محیط دارد که می‌تواند از آن‌ها برای توسعه، آزمایش، و استقرار API استفاده کند: «آزمایش» و «تولید». از محیط «آزمایشی» برای توسعه و آزمایش کردن میاناهای برنامه‌سازی کاربردی خود قبل‌از دردسترس قرار دادن آن‌ها برای عموم استفاده کنید. فقط توسعه‌دهندگان داخلی شما می‌توانند به «میاناهای برنامه‌سازی کاربردی» مستقرشده در محیط آزمایش دسترسی داشته باشند. میاناهای برنامه‌سازی کاربردی خود را در محیط «تولید» مستقر کنید تا آن‌ها را به‌صورت عمومی برای توسعه‌دهندگان نرم‌افزار دردسترس قرار دهید.

عیب‌یابی و آزمایش

‫Apigee یک ابزار ردیابی ارائه می‌دهد که به شما امکان می‌دهد جریان‌های درخواست و پاسخ سرتاسر را اشکال‌زدایی کنید. نتایج ردیابی سرصفحه‌ها و باربردهای درخواست و پاسخ، اجرای خط‌مشی، مقادیر متغیر، و هرگونه خطایی را که ممکن است درطول جریان رخ داده باشد نمایش می‌دهد.

نقاط داده کلیدی برای استفاده در عیب‌یابی:

  • مُهرهای زمان: از مُهرهای زمان برای دیدن مدت زمان اجرای هر مرحله استفاده کنید. مقایسه مُهر زمان به شما کمک می‌کند خط‌مشی‌هایی را که اجرای آن‌ها بیشترین زمان را می‌برد و تماس‌های API شما را کند می‌کند جدا کنید.
  • مسیر پایه: با درستی‌سنجی مسیر پایه، می‌توانید مطمئن شوید که خط‌مشی پیام را به سرور صحیح هدایت می‌کند.
  • نتایج اجرای خط‌مشی: این نتایج به شما امکان می‌دهد ببینید آیا پیام همان‌طور که انتظار می‌رود تغییر می‌کند، مثلاً آیا پیام از XML به JSON تبدیل می‌شود یا آیا پیام در حافظه نهان ذخیره می‌شود.

شکل زیر نتایج ردیابی را نشان می‌دهد:

زبانه «ردیابی» را که در ویرایشگر پراکسی API در «واسط کاربر Edge» انتخاب شده است نشان می‌دهد.

هر جلسه «ردیابی» به مراحل اصلی زیر تقسیم می‌شود:

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