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

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

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

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

برای نمای کلی فرایند ایجاد یک پراکسی API، این ویدیو را تماشا کنید.

ایجاد پراکسی API بااستفاده از میانا

آسان‌ترین راه برای ایجاد پراکسی API استفاده از جادوگر «ایجاد پراکسی» است.

Edge

برای دسترسی به دستیار «ایجاد پراکسی» بااستفاده از «میانای Edge»:

  1. به سیستم apigee.com/edge وارد شوید.
  2. در نوار پیمایش سمت راست، توسعه > پراکسی‌های API را انتخاب کنید.
  3. روی +پراکسی کلیک کنید.

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

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

میانای کاربر Edge جدید (ابر خصوصی)

برای دسترسی به جادوگر «ایجاد پراکسی» بااستفاده از «واسط کاربر Edge جدید»:

  1. در http://host:3001/edge به سیستم «میانای کاربر Edge جدید» وارد شوید. در اینجا، host نشانی IP یا نام ساناد میزبان اجرای «میانای کاربر Edge جدید» است.
  2. در نوار پیمایش سمت راست، توسعه > پراکسی‌های API را انتخاب کنید.
  3. روی +پراکسی کلیک کنید.

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

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

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

نوع شرح
پراکسی معکوس (رایج‌ترین)

پراکسی API که درخواست‌های ورودی را به سرویس‌های زیرینه HTTP موجود هدایت می‌کند. می‌تواند میانای برنامه‌سازی کاربردی JSON یا XML باشد. در ادامه این بخش، ایجاد پیشکار معکوس برای سرویس HTTP را ببینید.

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

سرویس SOAP کارگزار نیابتی API تولیدشده از فایل WSDL. نمایان کردن سرویس وب مبتنی بر SOAP به‌عنوان پراکسی میانای برنامه‌سازی کاربردی را ببینید.
بدون هدف

کارگزار نیابتی API بدون زیرینه API («بدون هدف»). مشابه با ایجاد پروکسی معکوس برای سرویس HTTP که قبلاً توضیح داده شد، با این تفاوت که هنگام تعریف جزئیات پروکسی API، یک API موجود را مشخص نخواهید کرد.

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

هدف میزبانی‌شده

پراکسی API که به برنامه Node.js مستقر در محیط «هدف‌های میزبانی‌شده» هدایت می‌کند. نمای کلی «هدف‌های میزبانی‌شده» را ببینید.

بارگذاری بسته کارگزار بسته پراکسی API موجود (برای مثال، یکی از پراکسی‌های API نمونه موجود در GitHub.) وارد کردن پراکسی میانای برنامه‌سازی کاربردی از بسته پراکسی میانای برنامه‌سازی کاربردی را ببینید.

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

ایجاد پروکسی معکوس برای سرویس HTTP

‫Edge براساس دو نوع اطلاعات کارگزاران معکوس تولید می‌کند:

  • نشانی وب سرویس زیرینه
  • مسیر «نشانی وب یکنواخت» که «میانای برنامه‌سازی کاربردی» را که توسط پراکسی «میانای برنامه‌سازی کاربردی» برای برنامه‌های مصرف‌کننده نمایان خواهد شد به‌طور یکتا شناسایی می‌کند

نشانی وب سرویس زیرینه معمولاً نشان‌دهنده برنامه فعال‌شده با سرویسی است که متعلق به سازمان شما است. همچنین می‌تواند به یک API دردسترس عمومی اشاره کند. این API یا سرویس می‌تواند تحت کنترل شما باشد (برای مثال، برنامه داخلی منابع انسانی یا برنامه Rails در Cloud) یا می‌تواند API یا سرویس طرف سوم باشد (برای مثال، Twitter یا Instagram).

Edge

  1. به جادوگر «ایجاد پراکسی» که قبلاً در این بخش در ایجاد پراکسی API بااستفاده از UI توضیح داده شده است دسترسی پیدا کنید.
  2. در جادوگر «ایجاد پراکسی»، روی پراکسی معکوس (رایج‌ترین) کلیک کنید. برای تولید پراکسی از «مشخصات OpenAPI» موجود و معتبر، روی استفاده از مشخصات OpenAPI کلیک کنید. برای جزئیات این گزینه، به استفاده از «مشخصات OpenAPI» برای تولید پراکسی در زیر مراجعه کنید.
  3. در صفحه جزئیات جادوگر، اطلاعات زیر را وارد کنید.
    فیلد شرح
    نام نامی که برای API شما نمایش داده می‌شود. نویسه‌های الفباعددی، خط تیره (-)، یا زیرخط (_) را مشخص کنید.
    مسیر پایه

    تکه‌نشانی وب که پس‌از نشانی http(s)://[host] ‎ کارگزار نیابتی API شما ظاهر می‌شود. ‫Edge از نشانی وب مسیر پایه برای مطابقت و مسیریابی پیام‌های درخواست ورودی به پراکسی API مناسب استفاده می‌کند.

    NOTE: مسیر پایه کارگزار API به‌طور پیش‌فرض روی مقدار مشخص‌شده برای فیلد Name که به حروف کوچک تبدیل شده است تنظیم می‌شود.

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

    https://[host]/base_path/conditional_flow_path

    NOTE: مسیر پایه باید یکتا باشد؛ نمی‌توانید دو پراکسی API را با مسیر پایه یکسان پیاده‌سازی کنید. اگر یک پراکسی API مستقرشده را ویرایش کنید و مسیر پایه را روی همان مقدار مسیر پایه پراکسی API دیگری تنظیم کنید، Edge به‌طور خودکار پراکسی API را هنگام ذخیره کردن آن لغو استقرار می‌کند. قبل‌از اینکه بتوانید پراکسی API را مجدداً مستقر کنید، باید مسیر پایه را ویرایش کنید تا منحصربه‌فرد باشد.

    استفاده از کارت‌های جوکر در مسیرهای پایه

    از یک یا چند نویسه عام /*/ در مسیرهای پایه کارگزار نیابتی API استفاده کنید تا کارگزاران نیابتی API خود را در آینده ایمن کنید. برای مثال، مسیر پایه /team/*/members به مشتریان امکان می‌دهد https://[host]/team/blue/members و https://[host]/team/green/members را فراخوانی کنند بدون اینکه شما نیاز داشته باشید کارگزاران میانای برنامه‌سازی کاربردی جدیدی برای پشتیبانی از تیم‌های جدید ایجاد کنید. توجه داشته باشید که /**/ پشتیبانی نمی‌شود.

    شرح (اختیاری) شرح میانای برنامه‌سازی کاربردی.
    هدف (میانای برنامه‌سازی کاربردی موجود) نشانی وب سرویس زیرین که این پراکسی API فراخوانی می‌کند.
  4. در صفحه خط‌مشی‌های مشترک جادوگر، موارد زیر را پیکربندی کنید:
    • الزامات مجوز امنیتی تحت امنیت: مجوز. در ادامه این بخش، افزودن امنیت را ببینید.
    • پشتیبانی از «هم‌رسانی منبع میان‌مبدئی» (CORS) در بخش امنیت: مرورگر. در ادامه این بخش، افزودن پشتیبانی از CORS را ببینید.
    • سهمیه‌ها برای محافظت از سرویس زیرینه شما دربرابر ترافیک بالا در بخش Quota. سهمیه‌ها را ببینید. (اگر مجوز عبور انتخاب شده باشد، دردسترس نیست.)
    • اجرای محدودیت درآمدزایی برای سازمان‌های فعال‌کننده درآمدزایی تحت درآمدزایی. به اعمال محدودیت‌های درآمدزایی روی پراکسی‌های API مراجعه کنید.
  5. در صفحه میزبان‌های مجازی جادوگر، میزبان‌های مجازی را که نماینده API هنگام استقرار به آن‌ها ملحق می‌شود انتخاب کنید. برای اطلاعات بیشتر، درباره میزبان‌های مجازی را ببینید.
  6. در صفحه خلاصه، درصورت تمایل، محیط(های) استقرار را انتخاب کنید و روی ایجاد و استقرار کلیک کنید.

    پراکسی API جدید شما ایجاد و در محیط انتخابی مستقر می‌شود.

  7. برای نمایش صفحه جزئیات کارگزار نیابتی API، روی ویرایش کارگزار نیابتی کلیک کنید.

میانای کاربر Edge جدید (ابر خصوصی)

  1. به جادوگر «ایجاد پراکسی» که قبلاً در این بخش در ایجاد پراکسی API بااستفاده از UI توضیح داده شده است دسترسی پیدا کنید.
  2. در جادوگر «ایجاد پراکسی»، روی پراکسی معکوس (رایج‌ترین) کلیک کنید. برای تولید پراکسی از «مشخصات OpenAPI» موجود و معتبر، روی استفاده از مشخصات OpenAPI کلیک کنید. برای جزئیات این گزینه، به استفاده از «مشخصات OpenAPI» برای تولید پراکسی در زیر مراجعه کنید.
  3. در صفحه جزئیات جادوگر، اطلاعات زیر را وارد کنید.
    فیلد شرح
    نام نامی که برای API شما نمایش داده می‌شود. نویسه‌های الفباعددی، خط تیره (-)، یا زیرخط (_) را مشخص کنید.
    مسیر پایه

    تکه‌نشانی وب که پس‌از نشانی http(s)://[host] ‎ کارگزار نیابتی API شما ظاهر می‌شود. ‫Edge از نشانی وب مسیر پایه برای مطابقت و مسیریابی پیام‌های درخواست ورودی به پراکسی API مناسب استفاده می‌کند.

    NOTE: مسیر پایه کارگزار API به‌طور پیش‌فرض روی مقدار مشخص‌شده برای فیلد Name که به حروف کوچک تبدیل شده است تنظیم می‌شود.

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

    https://[host]/base_path/conditional_flow_path

    NOTE: مسیر پایه باید یکتا باشد؛ نمی‌توانید دو پراکسی API را با مسیر پایه یکسان پیاده‌سازی کنید. اگر یک پراکسی API مستقرشده را ویرایش کنید و مسیر پایه را روی همان مقدار مسیر پایه پراکسی API دیگری تنظیم کنید، Edge به‌طور خودکار پراکسی API را هنگام ذخیره کردن آن لغو استقرار می‌کند. قبل‌از اینکه بتوانید پراکسی API را مجدداً مستقر کنید، باید مسیر پایه را ویرایش کنید تا منحصربه‌فرد باشد.

    استفاده از کارت‌های جوکر در مسیرهای پایه

    از یک یا چند نویسه عام /*/ در مسیرهای پایه کارگزار نیابتی API استفاده کنید تا کارگزاران نیابتی API خود را در آینده ایمن کنید. برای مثال، مسیر پایه /team/*/members به مشتریان امکان می‌دهد https://[host]/team/blue/members و https://[host]/team/green/members را فراخوانی کنند بدون اینکه شما نیاز داشته باشید کارگزاران میانای برنامه‌سازی کاربردی جدیدی برای پشتیبانی از تیم‌های جدید ایجاد کنید. توجه داشته باشید که /**/ پشتیبانی نمی‌شود.

    شرح (اختیاری) شرح میانای برنامه‌سازی کاربردی.
    هدف (میانای برنامه‌سازی کاربردی موجود) نشانی وب سرویس زیرین که این پراکسی API فراخوانی می‌کند.
  4. در صفحه خط‌مشی‌های مشترک در دستیار، موارد زیر را پیکربندی کنید:
    • الزامات مجوز امنیتی تحت امنیت: مجوز. در ادامه این بخش، افزودن امنیت را ببینید.
    • پشتیبانی از «هم‌رسانی منبع میان‌مبدئی» (CORS) در بخش امنیت: مرورگر. در ادامه این بخش، افزودن پشتیبانی از CORS را ببینید.
    • سهمیه‌ها برای محافظت از سرویس زیرینه شما دربرابر ترافیک بالا در بخش Quota. سهمیه‌ها را ببینید. (اگر مجوز عبور انتخاب شده باشد، دردسترس نیست.)
    • اجرای محدودیت درآمدزایی برای سازمان‌های فعال‌کننده درآمدزایی تحت درآمدزایی. به اعمال محدودیت‌های درآمدزایی روی پراکسی‌های API مراجعه کنید.
  5. در صفحه میزبان‌های مجازی جادوگر، میزبان‌های مجازی را که نماینده API هنگام استقرار به آن‌ها ملحق می‌شود انتخاب کنید. برای اطلاعات بیشتر، درباره میزبان‌های مجازی را ببینید.
  6. در صفحه خلاصه، درصورت تمایل، محیط(های) استقرار را انتخاب کنید و روی ایجاد و استقرار کلیک کنید.

    پراکسی API جدید شما در محیط انتخابی ایجاد و مستقر می‌شود.

  7. روی ویرایش پراکسی کلیک کنید تا صفحه جزئیات پراکسی API نمایش داده شود.

وارد کردن پراکسی API از بسته پراکسی API

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

با تماشای این ویدیو یاد می‌گیرید که چگونه یک کارگزار API را از بسته کارگزار API ایجاد و وارد کنید.

Edge

برای وارد کردن پراکسی‌های API از دسته پراکسی API:

  1. به جادوگر «ایجاد پراکسی» که قبلاً در این بخش در ایجاد پراکسی API بااستفاده از UI توضیح داده شده است دسترسی پیدا کنید.
  2. روی بارگذاری بسته پراکسی کلیک کنید.
  3. در صفحه بارگذاری بسته پراکسی در دستیار پراکسی، اطلاعات زیر را وارد کنید.

    فیلد شرح
    بسته ZIP فایل ZIP حاوی پیکربندی پراکسی API. برای پیمایش به فایل، آن را بکشید و رها کنید یا کلیک کنید.
    نام نامی که برای API شما نمایش داده می‌شود. به‌طور پیش‌فرض، نام فایل ZIP بدون پسوند است.
  4. روی بعدی کلیک کنید.
  5. در صفحه خلاصه، درصورت تمایل، محیط(های) استقرار را انتخاب کنید و روی ایجاد و استقرار کلیک کنید
    پیام تأییدی نمایش داده می‌شود که ایجاد موفقیت‌آمیز پراکسی API جدیدتان را تأیید می‌کند.
  6. برای نمایش صفحه جزئیات کارگزار نیابتی API، روی ویرایش کارگزار نیابتی کلیک کنید.

میانای کاربر Edge جدید (ابر خصوصی)

برای وارد کردن پراکسی‌های API از دسته پراکسی API:

  1. به جادوگر «ایجاد پراکسی» که قبلاً در این بخش در ایجاد پراکسی API بااستفاده از UI توضیح داده شده است دسترسی پیدا کنید.
  2. روی بارگذاری بسته پراکسی کلیک کنید.
  3. در صفحه بارگذاری بسته پراکسی در دستیار پراکسی، اطلاعات زیر را وارد کنید.

    فیلد شرح
    بسته ZIP فایل ZIP حاوی پیکربندی پراکسی API. برای پیمایش به فایل، آن را بکشید و رها کنید یا کلیک کنید.
    نام نامی که برای API شما نمایش داده می‌شود. به‌طور پیش‌فرض، نام فایل ZIP بدون پسوند است.
  4. روی بعدی کلیک کنید.
  5. در صفحه خلاصه، درصورت تمایل، محیط(های) استقرار را انتخاب کنید و روی ایجاد و استقرار کلیک کنید.
    پیامی مبنی بر تأیید ایجاد موفقیت‌آمیز پراکسی API جدید نمایش داده می‌شود.
  6. روی ویرایش پراکسی کلیک کنید تا صفحه جزئیات پراکسی API نمایش داده شود.

نمایان کردن سرویس وب مبتنی بر SOAP به‌عنوان پراکسی API

در «دستیار ایجاد پراکسی»، روی سرویس SOAP کلیک کنید و برای ایجاد پراکسی عبوری یا مبتنی بر REST برای سرویس SOAP، دستیار را دنبال کنید. برای جزئیات، نمایان کردن سرویس SOAP به‌عنوان پراکسی API را ببینید.

درحال افزودن امنیت

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

تنفیذ امنیتی شرح
کلید میانای برنامه‌سازی کاربردی درستی‌سنجی ساده کلید میانای برنامه‌سازی کاربردی را به پراکسی میانای برنامه‌سازی کاربردی که تعریف می‌کنید اضافه می‌کند. در پاسخ، «پلاتفرم API» خط‌مشی VerifyAPIKey و خط‌مشی AssignMessage را به پراکسی API شما اضافه می‌کند. خط‌مشی VerifyAPIKey کلیدهای API ارائه‌شده توسط برنامه‌های درخواست‌کننده را اعتبارسنجی می‌کند. خط‌مشی AssignMessage کلید API را که در تماس API به‌عنوان پارامتر پُرسمان ارائه شده است از درخواست بازارسال‌شده به سرور زیرینه جدا می‌کند.
OAuth 2.0 اصالت‌سنجی مبتنی بر OAuth 2.0 را به پراکسی API شما اضافه می‌کند. ‫Apigee Edge به‌طور خودکار دو خط‌مشی به پراکسی API شما اضافه می‌کند: یک خط‌مشی برای درستی‌سنجی کردن کد دسترسی و خط‌مشی دیگر برای حذف کد دسترسی از پیام قبل‌از بازارسال آن به سرویس زیرینه. برای آشنایی با نحوه دریافت کد دسترسی، به OAuth مراجعه کنید.
گذر (بدون مجوز) مجوز لازم نیست. درخواست‌ها بدون هیچ‌گونه بررسی امنیتی در Apigee Edge به زیرینه ارسال می‌شوند.

افزودن پشتیبانی برای CORS

‫CORS (هم‌رسانی منبع میان‌مبدئی) یک سازوکار استاندارد است که به مرورگر وب اجازه می‌دهد درخواست‌های مستقیمی به دامنه‌ای دیگر ارسال کند. استاندارد CORS مجموعه‌ای از سرایندهای HTTP را تعریف می‌کند که مرورگرها و سرورهای وب برای پیاده‌سازی ارتباط بین دامنه‌ای استفاده می‌کنند.

با انتخاب افزودن سرایندهای CORS در صفحه خط‌مشی‌های مشترک در دستیار «ایجاد پراکسی»، می‌توانید پشتیبانی از CORS را به API خود اضافه کنید.

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

استفاده از «مشخصات OpenAPI» برای تولید پراکسی‌ها

این بخش درباره گزینه «استفاده از OpenAPI» که برای تولید از «مشخصات OpenAPI» دردسترس است بحث می‌کند انواع زیر از پراکسی‌های میانای برنامه‌سازی کاربردی: معکوس، Node.js، یا بدون هدف.

«مشخصات OpenAPI» چیست؟

نشان‌واره «ابتکار میانای برنامه‌سازی کاربردی باز»«ابتکار عمل Open API (OAI) بر ایجاد، توسعه، و ترویج یک قالب توصیف API بی‌طرفانه فروشنده براساس مشخصات Swagger تمرکز دارد.» برای کسب اطلاعات بیشتر درباره «طرح ابتکاری Open API»، به https://openapis.org مراجعه کنید.

مشخصات OpenAPI از قالب استانداردی برای توصیف یک RESTful API استفاده می‌کند. «مشخصات OpenAPI» که به قالب JSON یا YAML نوشته شده است، برای ماشین قابل‌خواندن است، اما برای انسان‌ها نیز آسان است که آن را بخوانند و بفهمند. این مشخصات عناصری از میانای برنامه‌سازی کاربردی را توصیف می‌کند، ازجمله مسیر پایه، مسیرها و فعل‌ها، سرایندها، پارامترهای پُرسمان، عملیات، انواع محتوا، شرح‌های پاسخ، و موارد دیگر. علاوه‌براین، از «مشخصات OpenAPI» معمولاً برای تولید مستندات API استفاده می‌شود.

در اینجا بخشی از «مشخصات OpenAPI» را می‌بینید که سرویس هدف ساختگی Apigee را توصیف می‌کند، http://mocktarget.apigee.net. برای اطلاعات بیشتر، https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi را ببینید.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...

ازطریق «دستیار ساختن پراکسی»، می‌توانید «مشخصات OpenAPI» را وارد کنید و از آن برای تولید پراکسی API استفاده کنید. پس‌از تولید پراکسی، می‌توانید از «میانای کاربر Edge» برای توسعه بیشتر آن استفاده کنید با افزودن خط‌مشی‌ها، پیاده‌سازی کد سفارشی، و غیره -- درست مثل هر پراکسی Edge.

ایجاد پراکسی API از «مشخصات OpenAPI»

کارگزاران میانای برنامه‌سازی کاربردی خود را از «مشخصات OpenAPI» ایجاد کنید. تنها با چند کلیک، یک پراکسی API با مسیرها، پارامترها، جریان‌های شرطی، و نقاط پایانی هدف که به‌طور خودکار تولید شده است خواهید داشت. سپس می‌توانید ویژگی‌هایی مثل امنیت OAuth، محدودیت نرخ، و حافظه نهان را اضافه کنید.

در دستیار «ایجاد پراکسی»، روی استفاده از مشخصات OpenAPI کلیک کنید و با دنبال کردن دستیار، پراکسی معکوس یا بدون هدف را از «مشخصات OpenAPI» ایجاد کنید. برای جزئیات، ایجاد پراکسی API از «مشخصات OpenAPI» را ببینید.

برای آشنایی با نحوه ایجاد پراکسی API از «مشخصات OpenAPI»، این ویدیو را تماشا کنید.

به‌روزرسانی جریان‌ها در یک پراکسی API بااستفاده از «مشخصات OpenAPI»

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

برای به‌روز کردن جریان‌ها در یک پراکسی API بااستفاده از «مشخصات OpenAPI»:

  1. مسیرهای منبع جدید را به «مشخصات OpenAPI» اضافه کنید. به ویرایش مشخصات OpenAPI موجود مراجعه کنید.
  2. «پراکسی API» را در «واسط کاربر» باز کنید و روی برگه توسعه کلیک کنید.
  3. در «پیمایشگر»، روی + در کنار نقطه پایانی «پراکسی» که می‌خواهید به‌روز کنید کلیک کنید.
    چارگوش گفتگوی «جریان شرطی جدید» باز می‌شود.
  4. اگر از OpenAPI ازقبل انتخاب نشده است، روی آن کلیک کنید.
    اگر در «مشخصات OpenAPI» منابعی وجود داشته باشد که در پراکسی API جریان شرطی متناظر نداشته باشد، این منابع در چارگوش نشان داده می‌شوند، همان‌طور که در شکل زیر نشان داده شده است. منابعی که به‌عنوان جریان در پراکسی API فعلی نشان داده نمی‌شوند. این مثال شامل /loveapis،‏ /ip،‏ /json، و /xml می‌شود.
  5. هریک از منابعی را که می‌خواهید برای آن‌ها جریان شرطی اضافه کنید انتخاب کنید.
  6. روی افزودن کلیک کنید.

جریان‌های شرطی به پراکسی API شما اضافه می‌شود.

ایجاد نسخه جدیدی از پراکسی API

نسخه جدیدی از پراکسی API ایجاد کنید، همان‌طور که در زیر توضیح داده شده است.

Edge

برای ایجاد نسخه جدیدی از پراکسی API بااستفاده از «واسط کاربر Edge»:

  1. به سیستم apigee.com/edge وارد شوید.
  2. در نوار پیمایش سمت راست، توسعه > پراکسی‌های API را انتخاب کنید.
  3. روی پراکسی API در فهرستی که می‌خواهید کپی کنید کلیک کنید.
  4. پروژه > ذخیره به‌عنوان بازبینی جدید را انتخاب کنید.

میانای کاربر Edge جدید (ابر خصوصی)

برای ایجاد یک نسخه جدید از پراکسی API بااستفاده از «واسط کاربر New Edge»:

  1. در http://host:3001/edge به سیستم «میانای کاربر Edge جدید» وارد شوید. در اینجا، host نشانی IP یا نام ساناد میزبان اجرای «میانای کاربر Edge جدید» است.
  2. در نوار پیمایش سمت راست، توسعه > پراکسی‌های API را انتخاب کنید.
  3. روی پراکسی API در فهرستی که می‌خواهید کپی کنید کلیک کنید.
  4. پروژه > ذخیره به‌عنوان بازبینی جدید را انتخاب کنید.

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

کارگزار میانای برنامه‌سازی کاربردی موجود را در کارگزار میانای برنامه‌سازی کاربردی جدیدی کپی کنید، همان‌طور که در زیر توضیح داده شده است.

Edge

برای کپی کردن پراکسی API بااستفاده از Edge UI:

  1. به سیستم apigee.com/edge وارد شوید.
  2. در نوار پیمایش سمت راست، توسعه > پراکسی‌های API را انتخاب کنید.
  3. روی پراکسی API در فهرستی که می‌خواهید کپی کنید کلیک کنید.
  4. پروژه > ذخیره به‌عنوان پراکسی جدید API را انتخاب کنید.
  5. در کادر گفتگوی «ذخیره به‌عنوان پراکسی جدید»، نام پراکسی جدید API را وارد کنید.
  6. روی افزودن کلیک کنید.

میانای کاربر Edge جدید (ابر خصوصی)

برای کپی کردن پراکسی API بااستفاده از «واسط کاربر Edge جدید»:

  1. در http://host:3001/edge به سیستم «میانای کاربر Edge جدید» وارد شوید. در اینجا، host نشانی IP یا نام ساناد میزبان اجرای «میانای کاربر Edge جدید» است.
  2. در نوار پیمایش سمت راست، توسعه > پراکسی‌های API را انتخاب کنید.
  3. روی پراکسی API در فهرستی که می‌خواهید کپی کنید کلیک کنید.
  4. پروژه > ذخیره به‌عنوان پراکسی جدید API را انتخاب کنید.
  5. در کادر گفتگوی «ذخیره به‌عنوان پراکسی جدید»، نام پراکسی جدید API را وارد کنید.
  6. روی افزودن کلیک کنید.

درحال پشتیبان‌گیری از پراکسی میانای برنامه‌سازی کاربردی

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

ایجاد پراکسی API بااستفاده از API

برای ایجاد یک پراکسی API بااستفاده از API، به API پراکسی‌های API مراجعه کنید.