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

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

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

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

API چیست؟

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

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

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

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

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

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

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

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

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

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

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

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

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

سیاست چیست؟

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

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

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

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

بیشتر بدانید