درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
میاناهای برنامه‌سازی کاربردی را در درگاهتان منتشر کنید تا آن‌ها را برای مصرف توسعه‌دهندگان نرم‌افزار دردسترس قرار دهید، همان‌طور که در بخش‌های زیر توضیح داده شده است.
نمای کلی انتشار میانای برنامه‌سازی کاربردی
فرایند انتشار «میاناهای برنامه‌سازی کاربردی» در درگاه شما فرایندی دو مرحله‌ای است:
- محصول API را که می‌خواهید در درگاهتان منتشر کنید انتخاب کنید.
- اسناد مرجع میانای برنامه‌سازی کاربردی را از نمای فوری «مشخصات OpenAPI» خود به‌طور خودکار تولید کنید تا توسعه‌دهندگان برنامه بتوانند درباره میاناهای برنامه‌سازی کاربردی شما اطلاعات کسب کنند. (برای اطلاعات بیشتر درباره عکس‌های آنی، به عکس آنی «مشخصات OpenAPI» چیست؟ مراجعه کنید.
وقتی یک API را در درگاهتان منتشر می‌کنید، به‌روزرسانی‌های زیر به‌طور خودکار در درگاهتان انجام می‌شود:
صفحه «مرجع میانای برنامه‌سازی کاربردی» به درگاهتان اضافه می‌شود
صفحه «مرجع میانای برنامه‌سازی کاربردی» مستندات مرجع میانای برنامه‌سازی کاربردی را که از نمای فوری «مشخصات OpenAPI» خودتان به‌طور خودکار تولید می‌کنید نمایش می‌دهد. توسعه‌دهندگان می‌توانند اسناد میانای برنامه‌سازی کاربردی شما را مرور کنند و روی امتحان کردن کلیک کنند تا درخواست میانای برنامه‌سازی کاربردی ایجاد کنند و برونداد را ببینند.توجه: نمی‌توانید محتوای این صفحه را مستقیماً ویرایش کنید؛ این صفحه در فهرست صفحات در درگاه شما نشان داده نمی‌شود.
پیوندی به صفحه «مرجع میانای برنامه‌سازی کاربردی» به صفحه «میاناهای برنامه‌سازی کاربردی» اضافه می‌شود
صفحه «میاناهای برنامه‌سازی کاربردی» (همراه با درگاه نمونه) فهرستی از همه میاناهای برنامه‌سازی کاربردی منتشرشده در درگاهتان را به‌همراه پیوندهایی به اسناد مرجع میانای برنامه‌سازی کاربردی مربوطه برای کسب اطلاعات بیشتر ارائه می‌دهد.توجه: نمی‌توانید محتوای این صفحه را مستقیماً ویرایش کنید؛ این صفحه در فهرست صفحات در درگاه شما نشان داده نمی‌شود.
تصویر لحظه‌ای «مشخصات OpenAPI» چیست؟
«مشخصات OpenAPI» در کل چرخه حیات میانای برنامه‌سازی کاربردی به‌عنوان منبع حقیقت عمل می‌کند. از این مشخصات یکسان در هر مرحله از چرخه حیات API، از توسعه تا انتشار و نظارت، استفاده می‌شود. وقتی مشخصاتی را اصلاح می‌کنید، باید از تأثیر تغییرات بر میانای برنامه‌سازی کاربردی خود در مراحل دیگر چرخه حیات، همان‌طور که در اگر مشخصاتی را اصلاح کنم چه اتفاقی می‌افتد؟ توضیح داده شده است، آگاه باشید.
وقتی میانای برنامه‌سازی کاربردی خود را منتشر می‌کنید، از «مشخصات OpenAPI» عکس فوری می‌گیرید تا مستندات مرجع میانای برنامه‌سازی کاربردی را تولید کنید. آن نمای فوری نشان‌دهنده نسخه خاصی از مشخصات در فروشگاه مشخصات است. اگر «مشخصات OpenAPI» را بااستفاده از ویرایشگر مشخصات تغییر دهید، ممکن است تصمیم بگیرید برای نشان دادن آخرین تغییرات در مستندات مرجع API، عکس فوری دیگری از مشخصات بگیرید.
افزودن پشتیبانی از CORS به پراکسی‌های API
قبل‌از انتشار «میاناهای برنامه‌سازی کاربردی»، باید پشتیبانی CORS را به پراکسی‌های «میانای برنامه‌سازی کاربردی» خود اضافه کنید تا از درخواست‌های بین مبدأ سمت مشتری پشتیبانی کنید.
CORS (هم‌رسانی منبع میان‌مبدئی) یک سازوکار استاندارد است که به فراخوانی‌های JavaScript XMLHttpRequest (XHR) اجراشده در صفحه وب اجازه می‌دهد با منابع دامنه‌های غیرمبدأ تعامل داشته باشند. CORS راه‌حلی است که معمولاً برای خط‌مشی مبدأ یکسان که همه مرورگرها آن را اجرا می‌کنند پیاده‌سازی می‌شود. برای مثال، اگر از کد جاوا اسکریپت که در مرورگرتان اجرا می‌شود، فراخوانی XHR به Twitter API انجام دهید، فراخوانی ناموفق خواهد بود. دلیل این امر این است که دامنه‌ای که صفحه را به مرورگر شما ارائه می‌دهد با دامنه‌ای که «میانای برنامه‌سازی کاربردی Twitter» را ارائه می‌دهد یکسان نیست. CORS با اجازه دادن به سرورها برای «موافقت» با هم‌رسانی منبع میان‌مبدئی، راه‌حلی برای این مشکل ارائه می‌دهد.
برای کسب اطلاعات درباره افزودن پشتیبانی از «اشتراک منابع متقابل مبدأ» به پراکسی‌های میانای برنامه‌سازی کاربردی قبل‌از انتشار میاناهای برنامه‌سازی کاربردی، به افزودن پشتیبانی از «اشتراک منابع متقابل مبدأ» به پراکسی میانای برنامه‌سازی کاربردی مراجعه کنید.
توجه: اکثر مرورگرهای مدرن CORS را اجرا می‌کنند. فهرست کامل مرورگرهای پشتیبانی‌شده را مرور کنید. برای شرح دقیق CORS، به توصیه W3C درباره هم‌رسانی منبع میان‌مبدئی مراجعه کنید.
کاوش صفحه «میاناهای برنامه‌سازی کاربردی»
برای دسترسی به صفحه «میاناهای برنامه‌سازی کاربردی»:
- انتشار > درگاه‌ها را انتخاب کنید و درگاهتان را انتخاب کنید.
- روی میاناهای برنامه‌سازی کاربردی در صفحه اصلی درگاه کلیک کنید.
یا می‌توانید میاناهای برنامه‌سازی کاربردی را در منوِ کرکره‌ای در نوار پیمایش بالا انتخاب کنید.
فهرست میاناهای برنامه‌سازی کاربردی نمایش داده می‌شود.
همان‌طور که در شکل قبلی برجسته شده است، صفحه «میاناهای برنامه‌سازی کاربردی» به شما امکان می‌دهد:
- جزئیات میاناهای برنامه‌سازی کاربردی موجود در درگاهتان را مشاهده کنید
- افزودن میانای برنامه‌سازی کاربردی به درگاه
- برای به‌روزرسانی مستندات مرجع API، از «مشخصات OpenAPI» مرتبط با محصول API عکس فوری بگیرید
- انتشار یا لغو انتشار یک API در درگاه خود
- مدیریت مخاطبان میانای برنامه‌سازی کاربردی در درگاه
- ویرایش مشخصات منسوب (به ایجاد مشخصات بااستفاده از ویرایشگر مشخصات مراجعه کنید)
- برداشتن یک API از درگاه
- به‌سرعت میاناهای برنامه‌سازی کاربردی «یتیم» را که محصول API مرتبط آن‌ها از Edge برداشته شده است شناسایی کنید و محصول API را دوباره بسازید یا API را از درگاهتان حذف کنید
افزودن میانای برنامه‌سازی کاربردی به درگاه
توجه: حداکثر ۱۰۰ «میانای برنامه‌سازی کاربردی» می‌توانید به درگاهتان اضافه کنید.
برای افزودن یک API به درگاه خود:
- انتشار > درگاه‌ها را انتخاب کنید و درگاهتان را انتخاب کنید.
- روی میاناهای برنامه‌سازی کاربردی در صفحه اصلی درگاه کلیک کنید.
همچنین می‌توانید میاناهای برنامه‌سازی کاربردی را در منو کرکره‌ای در نوار پیمایش بالا انتخاب کنید. - روی + API کلیک کنید.
کادر گفتگوی «افزودن محصول API به درگاه» نمایش داده می‌شود. در برگه «محصول API» در چارگوش گفتگو، محصول API موردنظرتان را برای افزودن به درگاه انتخاب کنید.
روی بعدی کلیک کنید.
منبع موردنظر را برای استفاده در عکس فوری انتخاب کنید.
اگر پراکسی API را که در محصول API گنجانده شده است بااستفاده از «مشخصات OpenAPI» ایجاد کرده‌اید، مشخصات را از فهرست کرکره‌ای انتخاب کنید.
یا اینکه می‌توانید موارد زیر را انتخاب کنید:
- بدون مشخصات و افزودن مشخصات بعداز انتشار API، همان‌طور که در گرفتن نمای لحظه‌ای از مشخصات توضیح داده شده است.
- برای انتخاب یا بارگذاری مشخصات جدید، مشخصات دیگری را انتخاب کنید.
برای انتشار API در درگاه خود، چارگوش انتخاب منتشرشده را انتخاب کنید. اگر آماده انتشار API نیستید، منتشرشده را لغو انتخاب کنید.
بعداً می‌توانید تنظیمات را تغییر دهید، همان‌طور که در انتشار یا لغو انتشار API در درگاه توضیح داده شده است.در بخش «مخاطب»، یکی از گزینه‌های زیر را برای مدیریت مخاطب API خود با مجاز کردن دسترسی به این موارد انتخاب کنید:
- کاربران ناشناس تا به همه کاربران اجازه دهید صفحه را ببینند.
- کاربران ثبت‌شده تا فقط کاربران ثبت‌شده بتوانند صفحه را ببینند.
همان‌طور که در مدیریت مخاطبان برای یک API در درگاه توضیح داده شده است، می‌توانید این تنظیم را بعداً تغییر دهید.
روی تمام کلیک کنید؛
از مشخصات عکس آنی بگیرید
پس‌از انتشار API، در هر زمانی می‌توانید یک عکس فوری جدید از «مشخصات OpenAPI» بگیرید تا مستندات مرجع API منتشرشده در درگاهتان را به‌روز کنید.
برای گرفتن نمای فوری از «مشخصات OpenAPI»:
- انتشار > درگاه‌ها را انتخاب کنید و درگاهتان را انتخاب کنید.
- روی میاناهای برنامه‌سازی کاربردی در صفحه اصلی درگاه کلیک کنید.
همچنین می‌توانید میاناهای برنامه‌سازی کاربردی را در منو کرکره‌ای در نوار پیمایش بالا انتخاب کنید. - مکان‌نما را روی API موردنظرتان برای گرفتن چرخ‌عکس قرار دهید تا کنش‌ها نمایش داده شود.
روی
کلیک کنید. توجه: اگر نمای لحظه‌ای شما با مشخصات منبع انتخاب‌شده به‌روز باشد، پیامی نمایش داده می‌شود.
مشخصات موجود را از منو کرکره‌ای «منبع چسبنده» انتخاب کنید یا انتخاب مشخصات دیگر را انتخاب کنید تا مشخصات جدیدی را برای استفاده در تولید مستندات API انتخاب یا بارگذاری کنید. یا می‌توانید بدون مشخصات را انتخاب کنید تا مشخصات کنونی را بردارید.
روی به‌روزرسانی عکس فوری (یا برداشتن عکس فوری، اگر «بدون مشخصات» را انتخاب کرده‌اید) کلیک کنید.
اسناد مرجع API از مشخصات تولید شده و به صفحه «مرجع API» اضافه می‌شود.
انتشار یا لغو انتشار یک API در درگاه
برای انتشار یا لغو انتشار یک API در درگاه خود:
- انتشار > درگاه‌ها را انتخاب کنید و درگاهتان را انتخاب کنید.
- روی میاناهای برنامه‌سازی کاربردی در صفحه اصلی درگاه کلیک کنید.
همچنین می‌توانید میاناهای برنامه‌سازی کاربردی را در منو کرکره‌ای در نوار پیمایش بالا انتخاب کنید. - مکان‌نما را روی میانای برنامه‌سازی کاربردی که می‌خواهید منتشر یا لغو انتشار کنید قرار دهید.
- روی
کلیک کنید. - چارگوش انتخاب فعال را برای انتشار API در درگاهتان انتخاب کنید. برای لغو انتشار میانای برنامه‌سازی کاربردی، فعال را لغو انتخاب کنید.
- روی ذخیره کلیک کنید.
مدیریت مخاطب برای میانای برنامه‌سازی کاربردی در درگاه
مخاطب میانای برنامه‌سازی کاربردی خود را در درگاهتان با مجاز کردن دسترسی به موارد زیر مدیریت کنید:
- همه کاربران
- فقط کاربران ثبت‌شده
برای مدیریت مخاطبان یک API در درگاه خود:
- انتشار > درگاه‌ها را انتخاب کنید و درگاهتان را انتخاب کنید.
- روی میاناهای برنامه‌سازی کاربردی در صفحه اصلی درگاه کلیک کنید.
همچنین می‌توانید میاناهای برنامه‌سازی کاربردی را در منو کرکره‌ای در نوار پیمایش بالا انتخاب کنید. - مکان‌نما را روی میانای برنامه‌سازی کاربردی که می‌خواهید مخاطب را برای آن مدیریت کنید قرار دهید تا کنش‌ها نمایش داده شود.
- روی کلیک کنید.
- در بخش «مخاطبان»، یکی از گزینه‌های زیر را انتخاب کنید:
- کاربران ناشناس برای اجازه دادن به همه کاربران برای مشاهده محصول API.
- کاربران ثبت‌شده برای اینکه فقط کاربران ثبت‌شده بتوانند محصول API را ببینند.
- روی ذخیره کلیک کنید.
برداشتن میانای API از درگاه
برای برداشتن یک API از درگاه:
- انتشار > درگاه‌ها را انتخاب کنید و درگاهتان را انتخاب کنید.
- روی میاناهای برنامه‌سازی کاربردی در صفحه اصلی درگاه کلیک کنید.
همچنین می‌توانید میاناهای برنامه‌سازی کاربردی را در منو کرکره‌ای در نوار پیمایش بالا انتخاب کنید. - مکان‌نما را روی «میانای برنامه‌سازی کاربردی» در فهرست قرار دهید تا منو کنش‌ها نمایش داده شود.
- روی
کلیک کنید.
عیب‌یابی کردن مشکلات «میاناهای برنامه‌سازی کاربردی» منتشرشده
هنگام استفاده از «امتحان کردن»، اگر خطای TypeError: Failed to fetch برگردانده شد، علل و راه‌حل‌های احتمالی زیر را درنظر بگیرید:
برای خطاهای محتوای مختلط، خطا ممکن است ناشی از مشکل شناخته‌شده swagger-ui باشد. یکی از راه‌حل‌های ممکن این است که مطمئن شوید در تعریف
schemesدر «مشخصات OpenAPI» خود، HTTPS را قبل‌از HTTP مشخص کرده‌اید. برای مثال:schemes: - https - httpبرای خطاهای محدودیت CORS (هم‌رسانی منبع میان‌مبدئی)، مطمئن شوید که CORS برای پراکسی‌های API شما پشتیبانی می‌شود. CORS یک سازوکار استاندارد است که درخواست‌های بین مبدأ سمت کارخواه را فعال می‌کند. به افزودن پشتیبانی CORS برای پراکسی میانای برنامه‌سازی کاربردی مراجعه کنید. مطمئن شوید که CORS در مرورگرتان نیز فعال باشد.