اصطلاحات پایه

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

چند مفهوم وجود دارد که ایده‌های رایجی با معنای منحصربه‌فرد در Apigee هستند.

مدت تعریف
API

میانای برنامه‌سازی کاربردی—میانایی که برای یک برنامه آسان می‌کند تا قابلیت‌ها یا داده‌های برنامه دیگر را مصرف کند.

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

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

پراکسی میانای برنامه‌سازی کاربردی

نمای بیرونی در Edge برای یک یا چند میانای برنامه‌سازی کاربردی، سرویس‌های HTTP عمومی، یا برنامه‌ها (مثل Node.js).

پراکسی API به‌عنوان مجموعه‌ای از فایل‌های پیکربندی، خط‌مشی‌ها، و کدی پیاده‌سازی می‌شود که به مجموعه‌ای از منابع ارائه‌شده توسط Apigee Edge متکی است. کارگزاران API را می‌توان بااستفاده از میانای کاربر مدیریت Apigee Edge تولید و پیکربندی کرد، یا می‌توان آن‌ها را به‌صورت محلی در ویرایشگر نوشتار یا IDE پیاده‌سازی کرد.

نمای ارائه‌شده توسط پراکسی میانای برنامه‌سازی کاربردی، میانای برنامه‌سازی کاربردی روبه‌توسعه‌دهنده را از خدمات پشتیبان جدا می‌کند و توسعه‌دهندگان را از تغییرات کد محافظت می‌کند و نوآوری در لبه را بدون تأثیر بر تیم‌های توسعه داخلی شما امکان‌پذیر می‌کند. با ایجاد تغییرات در زیرینه توسط تیم‌های توسعه، توسعه‌دهندگان بدون وقفه به فراخوانی همان میانای کاربری ادامه می‌دهند. ‫Apigee به شما امکان می‌دهد چندین میانای یکسان را برای یک API نمایان کنید و به این ترتیب می‌توانید امضای یک API را سفارشی‌سازی کنید تا نیازهای هم‌زمان چندین گروه توسعه‌دهنده را برآورده کنید.

مسیر پایه و منابع میانای برنامه‌سازی کاربردی

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

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

محصول میانای برنامه‌سازی کاربردی

مجموعه‌ای از منابع API (نشانی‌های وب) که با سهمیه یا طرح خدمات ترکیب شده است و در زمان طراحی برای توسعه‌دهندگان برنامه منتشر می‌شود. محصولات API می‌توانند به نوبه خود در بسته‌های API برای درآمدزایی دسته‌بندی شوند.

کلید API به یک یا چند محصول API محدود می‌شود و پیوندی بین برنامه و دسته نشانی‌های وب که برنامه اجازه دارد مصرف کند را اعمال می‌کند.

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

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

وقتی برنامه ثبت می‌شود، Apigee کلید میانای برنامه‌سازی کاربردی و رمزی تولید می‌کند که برنامه را شناسایی می‌کند. توسعه‌دهنده کلید میانای برنامه‌سازی کاربردی را در برنامه جاسازی می‌کند و برنامه هنگام ارسال درخواست‌ها کلید را ارائه می‌دهد. «سرویس‌های API» ازطریق اصالت‌سنجی مستقیم کلید API یا ازطریق OAuth، امنیت کلید API را پیاده‌سازی می‌کند.

محیط

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

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

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

برای هر سازمانی که عضو آن هستید، به حساب کاربری نیاز دارید. (اکثر کاربران فقط در یک سازمان حساب دارند.)

خط‌مشی

مرحله پردازشی که به‌عنوان واحد منطقی اتمی و قابل‌استفاده مجدد در جریان پردازش پراکسی میانای برنامه‌سازی کاربردی اجرا می‌شود.

عملکرد مبتنی بر خط‌مشی معمولاً شامل تبدیل قالب‌های پیام، اجرای کنترل دسترسی، فراخوانی سرویس‌های از دور برای دریافت اطلاعات بیشتر، پوشاندن داده‌های حساس از کاربران خارجی، بررسی محتوای پیام برای یافتن تهدیدهای احتمالی، ذخیره کردن پاسخ‌های رایج در حافظه نهان برای بهبود عملکرد، و غیره می‌شود.

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

مسیر منبع میانای برنامه‌سازی کاربردی مفهومی «آرامش‌بخش»، مسیر منبع یک شناسه منبع یکسان (URI) است که مسیر شبکه به منبعی معین را شناسایی می‌کند.
نسخه

نسخه رابط API توسعه‌دهنده.

برای مثال، pivotaltracker.com/services/v3، یا api.enterprise.apigee.com/v1.

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

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