آشنایی با API ها و پراکسی های API

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

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

ویدیو: برای آشنایی با پروکسی‌های API، این ویدیوی کوتاه را ببینید.

API چیست؟

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

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

Apigee Edge شما را قادر می‌سازد تا APIها را بسازید و اگر از قبل APIهایی دارید، آنها را مستقیماً در معرض نمایش قرار دهید، ضمن اینکه یک لایه مدیریت و قابلیت مشاهده اضافه می‌کنید. اگر سرویس‌های HTTP فعال دارید، مانند سرویس‌های وب مبتنی بر SOA، آنها را نیز می‌توان از طریق Apigee Edge به عنوان API در معرض نمایش قرار داد.

Edge همچنین شما را قادر می‌سازد تا با پیاده‌سازی برنامه‌های میزبانی‌شده روی پلتفرم API Services - بدون هیچ سرویس backend - API بسازید. می‌توانید این برنامه‌ها را با جاوا اسکریپت، جاوا و Node.js بسازید.

پروکسی API چیست؟

شما با پیاده‌سازی API Proxies، APIها را در Apigee Edge در معرض نمایش قرار می‌دهید. API Proxies، API مربوط به برنامه را از سرویس‌های backend شما جدا می‌کند و این برنامه‌ها را از تغییرات کد backend محافظت می‌کند. همزمان با ایجاد تغییرات backend در سرویس‌های شما، برنامه‌ها بدون هیچ وقفه‌ای به فراخوانی همان API ادامه می‌دهند.

در پیکربندی پروکسی API، دو نوع نقطه پایانی وجود دارد:

  • ProxyEndpoint: نحوه‌ی استفاده‌ی برنامه‌های کلاینت از APIهای شما را تعریف می‌کند. شما ProxyEndpoint را برای تعریف URL پروکسی API خود پیکربندی می‌کنید. پروکسی همچنین تعیین می‌کند که آیا برنامه‌ها از طریق HTTP یا HTTPS به پروکسی API دسترسی دارند یا خیر. شما معمولاً سیاست‌هایی را به ProxyEndpoint پیوست می‌کنید تا امنیت، بررسی سهمیه و سایر انواع کنترل دسترسی و محدود کردن نرخ را اعمال کنید.
  • TargetEndpoint: نحوه تعامل پروکسی API با سرویس‌های backend شما را تعریف می‌کند. شما TargetEndpoint را طوری پیکربندی می‌کنید که درخواست‌ها را به سرویس backend مناسب ارسال کند، از جمله تعریف هرگونه تنظیمات امنیتی، پروتکل HTTP یا HTTPS و سایر اطلاعات اتصال. می‌توانید سیاست‌هایی را به TargetEndpoint پیوست کنید تا اطمینان حاصل شود که پیام‌های پاسخ برای برنامه‌ای که درخواست اولیه را ارسال کرده است، به درستی قالب‌بندی شده‌اند.

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

درخواست‌های HTTP از طریق نقطه پایانی درخواست پروکسی وارد می‌شوند، به نقطه پایانی درخواست هدف منتقل می‌شوند، و سپس به سرویس‌های backend ارسال می‌شوند. پاسخ‌های HTTP از طریق نقطه پایانی پاسخ هدف وارد می‌شوند، به نقطه پایانی پاسخ پروکسی منتقل می‌شوند و سپس به کلاینت بازمی‌گردند.

چگونه یک پروکسی API ایجاد کنیم؟

یک پروکسی API شامل مجموعه‌ای از فایل‌های پیکربندی XML و کد (مانند جاوا اسکریپت و جاوا) است. Apigee روش‌های مختلفی برای ایجاد پروکسی‌های API ارائه می‌دهد، از جمله:

  • استفاده از رابط کاربری مدیریت Edge برای تعریف یک پروکسی API در یک رابط کاربری گرافیکی (GUI). برای اطلاعات بیشتر، به ساخت یک پروکسی API ساده مراجعه کنید.
  • ایجاد فایل‌های XML، به همراه سایر فایل‌های پشتیبانی که پروکسی API شما را تعریف می‌کنند و سپس وارد کردن آنها به Edge.
  • با ارسال یک سری درخواست REST به Edge، از API مدیریت Edge برای ایجاد پروکسی‌های API خود استفاده کنید.
  • یک برنامه Node.js را به عنوان یک پروکسی مستقر کنید. به بخش استقرار یک برنامه Node.js مستقل مراجعه کنید.

سیاست چیست؟

Edge شما را قادر می‌سازد تا با استفاده از Policyها ، رفتار API را بدون نوشتن هیچ کدی کنترل کنید. یک Policy مانند ماژولی است که یک تابع مدیریتی خاص و محدود را به عنوان بخشی از جریان درخواست/پاسخ پروکسی پیاده‌سازی می‌کند. Policyها به گونه‌ای طراحی شده‌اند که به شما امکان می‌دهند انواع رایج قابلیت‌های مدیریتی را به راحتی و با اطمینان به یک API اضافه کنید. Policyها ویژگی‌هایی مانند قابلیت‌های امنیتی، محدودکننده سرعت، تبدیل و میانجیگری را ارائه می‌دهند و شما را از نیاز به کدنویسی و نگهداری این قابلیت‌ها به تنهایی نجات می‌دهند.

اولین پروکسی API خود را ایجاد کنید

Apigee مجموعه‌ای از آموزش‌ها را ارائه می‌دهد که می‌توانید برای ایجاد اولین API خود از آنها استفاده کنید. با پروکسی Build your first API شروع کنید.

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

بیشتر بدانید