مرحله ۶: انتشار API

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

در این مرحله، با انجام مراحل زیر، یک «میانای برنامه‌سازی کاربردی» را در درگاه منتشر می‌کنید:
‫۱. ایجاد «مشخصات OpenAPI»
‫۲. ایجاد پراکسی API از مشخصات
‫۳. ایجاد محصول API
‫۴. انتشار API در درگاه

مرحله ۱: ایجاد «مشخصات OpenAPI»

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

برای ایجاد «مشخصات OpenAPI»:

1. در نوار پیمایش سمت راست، توسعه > مشخصات را انتخاب کنید تا صفحه مشخصات باز شود.
2. روی + مشخصات > وارد کردن نشانی وب کلیک کنید.
3. اطلاعات زیر را در چارگوش گفتگوی وارد کردن وارد کنید:
4. نام وارد کردن: helloworld

5. نشانی وب وارد کردن: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

6. روی وارد کردن کلیک کنید.

مرحله ۲: ایجاد پراکسی API از مشخصات

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

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

1. در صفحه «مشخصات»، مکان‌نما را روی مشخصات helloworld قرار دهید تا منو کنش‌ها نمایش داده شود.
2. برای تولید کردن پراکسی API از مشخصات، روی کلیک کنید.
   «دستیار ساختن پراکسی» باز می‌شود و صفحه «جزئیات» بااستفاده از مقادیر «مشخصات OpenAPI» ازپیش تکمیل می‌شود.
3. فیلد شرح را به‌صورت زیر ویرایش کنید: کارگزار نیابتی API برای سلام دنیا.
4. روی بعدی کلیک کنید.

5. در صفحه خط‌مشی‌ها:

   • در بخش امنیت: صدور مجوز، عبور (بدون مجوز) را انتخاب کنید.
   • در بخش امنیت: مرورگر، افزودن سرایندهای CORS را انتخاب کنید .

   

6. روی بعدی کلیک کنید.

7. در صفحه جریان‌ها، مطمئن شوید همه عملیات‌ها انتخاب شده باشند و روی بعدی کلیک کنید.
   

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

9. در صفحه خلاصه، محیطی را که می‌خواهید در آن مستقر کنید در بخش استقرار اختیاری انتخاب کنید.

   

10. روی ایجاد کردن کلیک کنید.

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

مرحله ۳: ایجاد محصول API

محصول API ایجاد کنید که حاوی منابع API باشد و بخواهید آن را دراختیار مصرف‌کنندگان API خود قرار دهید.

برای ایجاد محصول API:

1. در نوار پیمایش سمت راست، انتشار > محصولات API را انتخاب کنید تا صفحه «محصولات API» باز شود.
2. روی + محصول API کلیک کنید.
   صفحه «محصول جدید» نمایش داده می‌شود.
3. جزئیات محصول را برای محصول API خود وارد کنید.
   توجه: فیلدهای «نام نمایشی» و «شرح» به‌طور پیش‌فرض در پورتال هنگام انتشار محصول API نمایش داده می‌شوند. می‌توانید مقادیر را در مرحله ۴: انتشار API در درگاه ویرایش کنید.
   

   فیلد	مقدار
   نام	Hello World
   نام نمایشی	Hello World
   شرح	مثال ساده «سلام دنیا»
   محیط زیست	محیطی را که کارگزار نیابتی API در آن مستقر شده است انتخاب کنید.
   دسترسی	عمومی
   تأیید خودکار درخواست‌های دسترسی	فعال
   سهمیه	(خالی بگذارید)
   محدوده‌های OAuth مجاز	(خالی بگذارید)

4. در بخش منابع API، روی افزودن پراکسی کلیک کنید تا پراکسی‌های API را برای افزودن به محصول API خود شناسایی کنید.
   کادر گفتگوی افزودن منبع میانای برنامه‌سازی کاربردی نمایش داده می‌شود.
5. روی پراکسی API کلیک کنید (اگر قبلاً انتخاب نشده است) و Mock-Target-API را در فهرست انتخاب کنید.
6. روی افزودن کلیک کنید.
7. برای ذخیره کردن محصول API، روی ذخیره کلیک کنید.

   

مرحله ۴: انتشار API در درگاه

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

برای انتشار میانای برنامه‌سازی کاربردی در درگاهتان:

1. به صفحه «میاناهای برنامه‌سازی کاربردی» در درگاهتان بروید:
   1. در نوار پیمایش سمت راست، انتشار > درگاه‌ها را انتخاب کنید.
   2. برای باز کردن درگاه، در ردیف اولین درگاه من کلیک کنید.
   3. برای نمایش صفحه «میاناهای برنامه‌سازی کاربردی»، روی کاتالوگ میاناهای برنامه‌سازی کاربردی کلیک کنید.
2. روی + کلیک کنید.
3. در چارگوش گفتگوی افزودن محصول API به کاتالوگ، Hello World را انتخاب کنید و روی بعدی کلیک کنید.
4. در بخش جزئیات میانای برنامه‌سازی کاربردی، گزینه‌های زیر را پیکربندی کنید:
   • منتشرشده (در کاتالوگ فهرست‌شده) را انتخاب کنید تا میانای برنامه‌سازی کاربردی را در درگاهتان منتشر کنید.
   • برای تصویر نمایش:
     1. روی انتخاب تصویر کلیک کنید.
     2. از فهرست تصاویر موجود در چارگوش گفتگوی انتخاب تصویر، روی home-background.jpg کلیک کنید.
     3. روی انتخاب کلیک کنید.
     4. تصویر را پیش‌نمایش کنید و روی انتخاب کلیک کنید.
   • برای دسته‌ها، شروع به کار را وارد کنید و کلید Enter را فشار دهید.

   همه مقادیر دیگر را روی پیش‌فرض‌هایشان بگذارید.

5. در بخش اسناد میانای برنامه‌سازی کاربردی، برای تولید خودکار اسناد مرجع میانای برنامه‌سازی کاربردی از یک نمای فوری از «مشخصات OpenAPI» شما:
   1. سند Open API را انتخاب کنید.
   2. روی انتخاب سند کلیک کنید.
   3. برگه مشخصات من را انتخاب کنید (اگر قبلاً انتخاب نشده است).
   4. از فهرست مشخصات، helloworld را انتخاب کنید.
   5. روی انتخاب کلیک کنید.
6. برای ذخیره کردن جزئیات «میانای برنامه‌سازی کاربردی»، روی ذخیره کلیک کنید.

   

برای مشاهده مستندات مرجع API:

1. روی درگاه زنده کلیک کنید تا تغییرات را در درگاه زنده مشاهده کنید (یا اگر درگاه زنده ازقبل در زبانه دیگری باز است، آن را بازآوری کنید).
2. برای مشاهده «میانای برنامه‌سازی کاربردی» منتشرشده، در نوار پیمایش بالا روی میاناهای برنامه‌سازی کاربردی کلیک کنید.
3. برای مشاهده مستندات مرجع API، روی کارت Hello World کلیک کنید. میانای برنامه‌سازی کاربردی خودتان را امتحان کنید!

---

تبریک می‌گوییم! آموزش را باموفقیت تکمیل کردید. آماده‌اید تا بیشتر بدانید؟ به ساختن درگاه یکپارچه بروید.