API های خود را منتشر کنید

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

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

مروری بر انتشار API

فرآیند انتشار APIها در پورتال شما یک فرآیند دو مرحله ای است:

  1. محصول API را که می خواهید در پورتال خود منتشر کنید انتخاب کنید.
  2. مستندات مرجع API را از یک عکس فوری از سند OpenAPI یا طرح GraphQL خود ارائه دهید تا توسعه دهندگان برنامه بتوانند درباره API های شما اطلاعات کسب کنند. (برای اطلاعات بیشتر در مورد عکس های فوری، نگاه کنید به عکس فوری چیست؟ )

چه چیزی در پرتال منتشر می شود؟

هنگامی که یک API منتشر می کنید، به روز رسانی های زیر به طور خودکار در پورتال شما انجام می شود:
  • اسناد مرجع API. رابط ارائه شده به این بستگی دارد که آیا API خود را با استفاده از یک سند OpenAPI منتشر می کنید یا طرح GraphQL. ببینید:
  • پیوندی به صفحه مرجع API به صفحه API ها اضافه می شود

    صفحه APIها (همراه با پورتال نمونه ) فهرستی از همه APIهای منتشر شده در پورتال شما را به ترتیب حروف الفبا همراه با پیوندهایی به اسناد مرجع API مربوطه برای اطلاعات بیشتر ارائه می دهد. به صورت اختیاری، می توانید موارد زیر را سفارشی کنید:

    • تصویر نمایش داده شده برای هر کارت API
    • دسته‌هایی که برای برچسب‌گذاری APIها استفاده می‌شوند تا توسعه‌دهندگان بتوانند APIهای مرتبط را در صفحه APIها کشف کنند.

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

    • SmartDocs (OpenAPI)

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

    توسعه دهندگان می توانند مستندات مرجع SmartDocs API شما را بررسی کنند و از پنل Try this API برای درخواست API و مشاهده خروجی استفاده کنند. سعی کنید این API با نقاط پایانی ناامن یا نقاط پایانی ایمن با استفاده از احراز هویت پایه، کلید API یا OAuth، بر اساس روش امنیتی تعریف شده در سند OpenAPI شما، کار می کند. برای OAuth، جریان‌های زیر پشتیبانی می‌شوند: کد مجوز، رمز عبور، و اعتبار مشتری.

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

    کلیک کنید برای گسترش پنل Try this API. پانل گسترش یافته شما را قادر می سازد تا نمونه های curl call و کد را در قالب های مختلف مانند HTTP، Python، Node.js و غیره مشاهده کنید، همانطور که در زیر نشان داده شده است.

    گسترش یافته این پانل API را امتحان کنید

    GraphQL Explorer

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

    توسعه دهندگان می توانند از GraphQL Explorer برای بررسی اسناد تعاملی مبتنی بر طرحواره، ساخت و اجرای پرس و جوها، مشاهده نتایج پرس و جو و دانلود طرحواره استفاده کنند. برای ایمن کردن دسترسی به API خود، توسعه‌دهندگان می‌توانند سرصفحه‌های مجوز را در بخش Request Headers ارسال کنند.

    برای اطلاعات بیشتر در مورد GraphQL، به graphql.org مراجعه کنید.

    GraphQL Explorer در پورتال

    اسنپ ​​شات چیست؟

    هر سند OpenAPI یا GraphQL به عنوان منبع حقیقت در طول چرخه حیات یک API عمل می کند. سند یکسان در هر مرحله از چرخه حیات API، از توسعه تا انتشار و نظارت استفاده می‌شود. هنگامی که یک سند را اصلاح می کنید، باید از تأثیر تغییرات بر روی API خود در سایر مراحل چرخه حیات آگاه باشید، همانطور که در توضیح داده شده است اگر یک سند را اصلاح کنم چه اتفاقی می افتد؟

    هنگامی که API خود را منتشر می کنید، یک عکس فوری از سند OpenAPI یا GraphQL می گیرید تا مستندات مرجع API ارائه شود. آن عکس فوری نسخه خاصی از سند را نشان می دهد. اگر سند را تغییر دهید، ممکن است تصمیم بگیرید که یک عکس فوری دیگر از سند بگیرید تا آخرین تغییرات در اسناد مرجع API را منعکس کنید.

    درباره URL های برگشت به تماس

    اگر برنامه‌های شما به نشانی اینترنتی پاسخ به تماس نیاز دارند، مانند زمانی که از نوع اعطای کد مجوز OAuth 2.0 استفاده می‌کنید (اغلب به عنوان «OAuth سه‌پایه» نامیده می‌شود)، می‌توانید از برنامه‌نویسان بخواهید که هنگام ثبت برنامه‌های خود، نشانی وب پاسخ به تماس را مشخص کنند. URL برگشت به تماس معمولاً نشانی اینترنتی برنامه ای را مشخص می کند که برای دریافت کد مجوز از طرف برنامه مشتری تعیین شده است. برای اطلاعات بیشتر، به اجرای نوع اعطای کد مجوز مراجعه کنید.

    می‌توانید پیکربندی کنید که در هنگام ثبت برنامه هنگام افزودن یک API به پورتال خود، به URL بازگشت به تماس نیاز باشد یا نه. می‌توانید هر زمان که بخواهید این تنظیم را تغییر دهید، همانطور که در مدیریت URL پاسخ به تماس برای یک API توضیح داده شده است.

    هنگام ثبت یک برنامه، توسعه دهندگان باید یک URL بازگشت به تماس را برای همه APIهایی که به آن نیاز دارند وارد کنند، همانطور که در ثبت برنامه ها توضیح داده شده است.

    پروکسی API خود را برای پشتیبانی از "Try this API" پیکربندی کنید

    قبل از انتشار API های خود با استفاده از یک سند OpenAPI، باید پروکسی API خود را برای پشتیبانی از درخواست ها در پانل Try this API در مستندات مرجع SmartDocs API پیکربندی کنید، به شرح زیر:

    • پشتیبانی CORS را به پراکسی‌های API خود اضافه کنید تا درخواست‌های متقاطع سمت مشتری را اعمال کنید

      CORS یک مکانیسم استاندارد است که به فراخوانی های JavaScript XMLHttpRequest (XHR) اجازه می دهد تا در یک صفحه وب با منابع از دامنه های غیر اصلی تعامل داشته باشند. CORS راه حلی است که معمولاً برای " خط مشی همان مبدأ " اجرا می شود که توسط همه مرورگرها اجرا می شود.

    • اگر از احراز هویت اولیه یا OAuth2 استفاده می کنید، پیکربندی پروکسی API خود را به روز کنید

    جدول زیر الزامات پیکربندی پروکسی API را برای پشتیبانی از پانل Try this API در مستندات مرجع SmartDocs API بر اساس دسترسی احراز هویت، خلاصه می‌کند.

    دسترسی تأیید الزامات پیکربندی خط مشی
    هیچ یا کلید API پشتیبانی CORS را به پروکسی API خود اضافه کنید. برای راحتی، از نمونه راه حل CORS ارائه شده در GitHub استفاده کنید یا مراحل توضیح داده شده در افزودن پشتیبانی CORS به یک پروکسی API را دنبال کنید.
    احراز هویت اولیه مراحل زیر را انجام دهید:
    1. پشتیبانی CORS را به پروکسی API خود اضافه کنید. برای راحتی، از نمونه راه حل CORS ارائه شده در GitHub استفاده کنید یا مراحل توضیح داده شده در افزودن پشتیبانی CORS به یک پروکسی API را دنبال کنید.
    2. در خط‌مشی Add CORS AssignMessage، اطمینان حاصل کنید که هدر Access-Control-Allow-Headers دارای ویژگی authorization است. به عنوان مثال: 
      <Header name="Access-Control-Allow-Headers">
  origin, x-requested-with, accept, content-type, authorization
</Header>
    OAuth2
    1. پشتیبانی CORS را به پروکسی API خود اضافه کنید. برای راحتی، از نمونه راه حل CORS ارائه شده در GitHub استفاده کنید یا مراحل توضیح داده شده در افزودن پشتیبانی CORS به یک پروکسی API را دنبال کنید.
    2. در خط‌مشی Add CORS AssignMessage، اطمینان حاصل کنید که هدر Access-Control-Allow-Headers دارای ویژگی authorization است. به عنوان مثال: 
      <Header name="Access-Control-Allow-Headers">
  origin, x-requested-with, accept, content-type, authorization
</Header>
    3. رفتارهای غیر منطبق با RFC را در خط‌مشی OAuth2 خود اصلاح کنید. برای راحتی، از نمونه راه حل OAuth2 ارائه شده در GitHub استفاده کنید یا مراحل زیر را انجام دهید:
      • اطمینان حاصل کنید که عنصر <GrantType> در خط‌مشی OAuth2 روی request.formparam.grant_type (پارام فرم) تنظیم شده است. برای اطلاعات بیشتر، <GrantType> را ببینید.
      • اطمینان حاصل کنید که token_type در خط‌مشی OAuth2 روی Bearer تنظیم شده است و نه BearerToken پیش‌فرض.

    کاتالوگ API را کاوش کنید

    برای مشاهده کاتالوگ API: 1. Publish > Portals را انتخاب کنید و پورتال خود را انتخاب کنید. 2. روی کاتالوگ API در صفحه اصلی پورتال کلیک کنید. همچنین، می‌توانید کاتالوگ API را در منوی کشویی پورتال در نوار پیمایش بالا انتخاب کنید.

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

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

    همانطور که در شکل قبل مشخص شد، تب APIs شما را قادر می سازد:

    یک API به پورتال خود اضافه کنید

    برای افزودن یک API به پورتال خود:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.

    3. روی + کلیک کنید.

      افزودن یک محصول API به کاتالوگ نمایش داده می شود.

    4. محصول API را که می خواهید به پورتال خود اضافه کنید انتخاب کنید.

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

    6. محتوای اسناد مرجع API و قابلیت مشاهده آن در پورتال را پیکربندی کنید:

      میدان توضیحات
      منتشر شد برای انتشار API در پورتال خود ، Published را انتخاب کنید. اگر برای انتشار API آماده نیستید، کادر انتخاب را بردارید. می‌توانید بعداً تنظیم را تغییر دهید، همانطور که در Publish توضیح داده شد یا یک API را در پورتال خود لغو انتشار کنید .
      نمایش عنوان عنوان API خود را که در کاتالوگ نمایش داده می شود به روز کنید. به طور پیش فرض از نام محصول API استفاده می شود. می‌توانید بعداً عنوان نمایش را تغییر دهید، همانطور که در ویرایش عنوان نمایش و توضیحات توضیح داده شده است.
      توضیحات نمایش توضیحات API خود را که در کاتالوگ نمایش داده می شود به روز کنید. به طور پیش فرض، از توضیحات محصول API استفاده می شود. می‌توانید بعداً شرح نمایش را تغییر دهید، همانطور که در ویرایش عنوان نمایش و توضیحات توضیح داده شده است.
      از توسعه دهندگان بخواهید که URL بازگشت به تماس را مشخص کنند اگر می‌خواهید از برنامه‌نویسان برنامه بخواهید که URL بازگشت به تماس را مشخص کنند، آن را فعال کنید. همانطور که در مدیریت URL پاسخ به تماس برای یک API توضیح داده شده است، می‌توانید نشانی وب پاسخ به تماس را بعداً اضافه یا به‌روزرسانی کنید.
      اسناد API برای استفاده از یک سند OpenAPI:
      1. سند OpenAPI را انتخاب کنید.
      2. روی انتخاب سند کلیک کنید.
      3. یکی از مراحل زیر را انجام دهید:
        • روی تب My Specs کلیک کنید و یک مشخصات را از فروشگاه مشخصات انتخاب کنید.
        • روی تب آپلود فایل کلیک کنید و یک فایل را آپلود کنید.
        • روی زبانه Import from a URL کلیک کنید و مشخصات را از URL وارد کنید.
      4. روی انتخاب کلیک کنید.

      برای استفاده از طرحواره GraphQL:

      1. GraphQL Schema را انتخاب کنید.
      2. روی انتخاب سند کلیک کنید.
      3. به طرحواره GraphQL بروید و آن را انتخاب کنید.
      4. روی انتخاب کلیک کنید.

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

      قابلیت مشاهده API

      اگر در نسخه بتا ویژگی مدیریت مخاطب ثبت نام نکرده اید، یکی از گزینه های زیر را انتخاب کنید:

      • کاربران ناشناس به همه کاربران اجازه می دهند API را مشاهده کنند.
      • کاربران ثبت نام شده اجازه می دهند فقط کاربران ثبت نام شده بتوانند API را مشاهده کنند.

      اگر در نسخه بتا ویژگی مدیریت مخاطب ثبت نام کرده اید، یکی از گزینه های زیر را انتخاب کنید:

      • عمومی (قابل مشاهده برای همه) به همه کاربران اجازه می دهد تا API را مشاهده کنند.
      • کاربران احراز هویت شده برای اینکه فقط کاربران ثبت نام شده بتوانند API را مشاهده کنند.
      • مخاطبان انتخاب شده برای انتخاب مخاطبان خاصی که می خواهید قادر به مشاهده API باشند.

      می‌توانید بعداً نمایان بودن مخاطب را مدیریت کنید، همانطور که در مدیریت نمایان بودن یک API در پورتال خود توضیح داده شده است.

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

      دسته‌هایی را اضافه کنید که API به آنها برچسب‌گذاری می‌شود تا توسعه‌دهندگان برنامه بتوانند APIهای مرتبط را در صفحه APIها کشف کنند. برای شناسایی یک دسته:

      • یک دسته را از لیست کشویی انتخاب کنید.
      • یک دسته جدید را با تایپ کردن نام آن و فشار دادن Enter اضافه کنید. دسته جدید به صفحه دسته‌ها اضافه می‌شود و هنگام افزودن یا ویرایش سایر APIها در دسترس قرار می‌گیرد.

    7. روی ذخیره کلیک کنید.

    عکس فوری سند را مدیریت کنید

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

    برای مدیریت عکس فوری سند:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
    3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
    4. وضعیت عکس فوری را بررسی کنید. اگر قدیمی باشد، پیام زیر نمایش داده می شود: نماد و پیامی که نشان می دهد عکس فوری قدیمی است
    5. کلیک کنیدنماد ویرایش .
    6. یکی از کارهای زیر را انجام دهید:
      • برای بازخوانی یک عکس فوری از یک سند OpenAPI که قدیمی است، روی Refresh Snapshot کلیک کنید.
      • برای تغییر سندی که برای تولید اسناد API استفاده می‌شود، در زیر API documentation، روی Select Document کلیک کنید و سند جدید را انتخاب کنید.
    7. روی ذخیره کلیک کنید.

    مستندات مرجع API از سند ارائه شده و به صفحه مرجع API اضافه می شود. وضعیت عکس فوری به فعلی به روز می شود:

    نماد و پیام نشان می دهد که عکس فوری فعلی است

    یک API را در پورتال خود منتشر یا لغو انتشار کنید

    برای انتشار یا لغو انتشار یک API در پورتال خود:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
    3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
    4. کلیک کنیدویرایش نماد .
    5. در زیر جزئیات API، Published (ذکر شده در کاتالوگ) را انتخاب یا لغو انتخاب کنید تا API را به ترتیب در پورتال خود منتشر یا لغو کنید.
    6. روی ذخیره کلیک کنید.

    قابلیت مشاهده یک API را در پورتال خود مدیریت کنید

    با اجازه دادن به دسترسی به یک API در پورتال خود، مدیریت کنید:

    برای مدیریت نمایان بودن یک API در پورتال خود:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
    3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
    4. کلیک کنیدویرایش نماد .
    5. در قسمت مشاهده API، یکی از گزینه های زیر را انتخاب کنید:

    6. تنظیم دید را انتخاب کنید. اگر در نسخه بتا ویژگی مخاطبان ثبت نام کرده اید، یکی از گزینه های زیر را انتخاب کنید:

      • عمومی (قابل مشاهده برای همه) تا به همه کاربران اجازه مشاهده صفحه را بدهد.
      • کاربران احراز هویت شده تا فقط کاربران ثبت نام شده بتوانند صفحه را مشاهده کنند.
      • مخاطبان انتخاب شده برای انتخاب مخاطبان خاصی که می خواهید بتوانید صفحه را مشاهده کنید. به مدیریت مخاطبان پورتال خود مراجعه کنید.
      در غیر این صورت یکی از گزینه های زیر را انتخاب کنید:
      • کاربران ناشناس به همه کاربران اجازه مشاهده صفحه را می دهند.
      • کاربران ثبت نام شده اجازه می دهند فقط کاربران ثبت نام شده بتوانند صفحه را مشاهده کنند.

    7. روی ارسال کلیک کنید.

    URL بازگشت به تماس را برای یک API مدیریت کنید

    URL بازگشت به تماس را برای یک API مدیریت کنید. درباره URL های پاسخ به تماس رجوع کنید.

    برای مدیریت URL برگشت به تماس برای یک API:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
    3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
    4. کلیک کنیدویرایش نماد .
    5. در زیر جزئیات API، Published (ذکر شده در کاتالوگ) را انتخاب یا لغو انتخاب کنید تا API را به ترتیب در پورتال خود منتشر یا لغو کنید.
    6. روی ذخیره کلیک کنید.

    تصویر را برای یک کارت API مدیریت کنید

    با افزودن یا تغییر تصویر فعلی، تصویری را که با یک کارت API در صفحه API ظاهر می شود، مدیریت کنید.

    برای مدیریت تصویر برای یک کارت API:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
    3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
    4. کلیک کنیدویرایش نماد .

    5. در زیر جزئیات API:

      • برای مشخص کردن یا آپلود تصویر اگر در حال حاضر هیچ تصویری انتخاب نشده است، روی Select image کلیک کنید.
      • روی تغییر تصویر کلیک کنید تا تصویر دیگری را مشخص یا آپلود کنید.
      • برای حذف روی x در تصویر کلیک کنید.

      هنگام مشخص کردن یک تصویر، یا یک تصویر با یک URL خارجی که برای آیتم کاتالوگ استفاده می شود، یا یک مسیر فایل برای فایل های تصویری ذخیره شده در پورتال ، برای مثال، /files/book-tree.jpg را مشخص کنید. هنگام تعیین URL یک تصویر خارجی، تصویر در دارایی های شما آپلود نمی شود. علاوه بر این، بارگیری تصویر در پورتال یکپارچه منوط به در دسترس بودن آن خواهد بود که ممکن است توسط سیاست های امنیتی محتوا مسدود یا محدود شود.

    6. روی ذخیره کلیک کنید.

    یک API را با استفاده از دسته‌ها تگ کنید

    یک API را با استفاده از دسته‌ها به یکی از روش‌های زیر برچسب‌گذاری کنید:

    • دسته بندی هایی را که یک API به آنها برچسب گذاری شده است، در هنگام ویرایش API مدیریت کنید، همانطور که در زیر توضیح داده شده است.
    • هنگام ویرایش دسته، APIهای برچسب گذاری شده به یک دسته را مدیریت کنید.

    برای برچسب گذاری یک API به دسته ها هنگام ویرایش API:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
    3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
    4. کلیک کنیدویرایش نماد .
    5. در قسمت Categories کلیک کنید و یکی از مراحل زیر را انجام دهید:
      • یک دسته را از لیست کشویی انتخاب کنید.
      • یک دسته جدید را با تایپ کردن نام آن و فشار دادن Enter اضافه کنید. دسته جدید به صفحه دسته‌ها اضافه می‌شود و هنگام افزودن یا ویرایش سایر APIها در دسترس قرار می‌گیرد.
    6. برای برچسب گذاری API در دسته های بیشتر، تکرار کنید.
    7. روی ذخیره کلیک کنید.

    عنوان نمایش و توضیحات را ویرایش کنید

    برای ویرایش عنوان نمایش و توضیحات:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اید، روی تب APIs کلیک کنید.
    3. روی ردیف API که می خواهید ویرایش کنید کلیک کنید.
    4. کلیک کنیدویرایش نماد .
    5. فیلدهای عنوان نمایش و توضیحات نمایش را در صورت لزوم ویرایش کنید.
    6. روی ذخیره کلیک کنید.

    یک API را از پورتال خود حذف کنید

    برای حذف یک API از پورتال خود:

    1. به کاتالوگ API دسترسی داشته باشید .
    2. اگر قبلاً انتخاب نشده‌اند، APIها را انتخاب کنید.
    3. مکان نما خود را روی API در لیست قرار دهید تا منوی اقدامات نمایش داده شود.
    4. کلیک کنیدویرایش نماد.

    دسته‌های مورد استفاده برای کشف APIهای مرتبط را مدیریت کنید

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

    صفحه دسته ها را کاوش کنید

    برای مشاهده صفحه دسته بندی ها:

    1. Publish > Portals را انتخاب کنید و پورتال خود را انتخاب کنید.
    2. روی کاتالوگ API در صفحه اصلی پورتال کلیک کنید.

      همچنین، می‌توانید کاتالوگ API را در منوی کشویی پورتال در نوار پیمایش بالا انتخاب کنید.

    3. روی تب دسته ها کلیک کنید.

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

    برگه دسته‌ها که نام دسته، نام‌ها و تعداد کل APIهای اختصاص داده شده را نشان می‌دهد

    همانطور که در شکل قبل مشخص شده است، صفحه APIs شما را قادر می سازد:

    یک دسته اضافه کنید

    یک دسته را به یکی از روش های زیر اضافه کنید:

    دسته جدید به صفحه دسته‌ها اضافه می‌شود و هنگام افزودن یا ویرایش سایر APIها در دسترس قرار می‌گیرد.

    برای افزودن دستی یک دسته:

    1. به صفحه دسته ها دسترسی پیدا کنید .
    2. روی + کلیک کنید.
    3. نام دسته جدید خود را وارد کنید.
    4. در صورت تمایل، یک یا چند API را برای برچسب گذاری به دسته انتخاب کنید.
    5. روی ایجاد کلیک کنید.

    یک دسته را ویرایش کنید

    برای ویرایش یک دسته:

    1. به صفحه دسته ها دسترسی پیدا کنید .
    2. کلیک کنید .
    3. نام دسته را ویرایش کنید.
    4. برچسب های API را اضافه یا حذف کنید.
    5. روی ذخیره کلیک کنید.

    حذف یک دسته

    هنگامی که یک دسته را حذف می کنید، تمام برچسب های API آن دسته نیز حذف می شوند.

    برای حذف یک دسته:

    1. به صفحه دسته ها دسترسی پیدا کنید .
    2. مکان نما خود را روی دسته ای که می خواهید ویرایش کنید قرار دهید تا منوی اقدامات نمایش داده شود.
    3. کلیک کنید .
    4. نام دسته را ویرایش کنید.
    5. API ها را اضافه یا حذف کنید.
    6. روی ذخیره کلیک کنید.

    مشکلات مربوط به APIهای منتشر شده خود را عیب یابی کنید

    بخش‌های زیر اطلاعاتی را ارائه می‌کنند تا به شما در عیب‌یابی خطاهای خاص با APIهای منتشر شده ما کمک کنند.

    خطا: هنگام استفاده از Try this API، خطای برگشتی واکشی نشد

    هنگام استفاده از این API را امتحان کنید، اگر خطای TypeError: Failed to fetch برگردانده شد، دلایل و راهکارهای احتمالی زیر را در نظر بگیرید:

    • برای خطاهای محتوای مختلط، خطا ممکن است ناشی از یک مشکل شناخته شده swagger-ui باشد. یکی از راه‌حل‌های ممکن این است که مطمئن شوید HTTPS را قبل از HTTP در تعریف schemes در سند OpenAPI خود مشخص کرده‌اید. به عنوان مثال:

      schemes:
   - https
   - http

    • برای خطاهای محدودیت اشتراک‌گذاری منابع متقاطع (CORS)، مطمئن شوید که CORS برای پراکسی‌های API شما پشتیبانی می‌شود. CORS مکانیزم استانداردی است که درخواست‌های مبدأ متقاطع سمت مشتری را فعال می‌کند. به پیکربندی پروکسی API خود برای پشتیبانی از این API مراجعه کنید.

    خطا: هدر «Access-Control-Allow-Origin» حاوی چندین مقدار «*، *» است، اما فقط یک مورد مجاز است

    هنگام استفاده از Try this API، اگر سرصفحه Access-Control-Allow-Origin از قبل وجود داشته باشد، ممکن است پیام خطای زیر را دریافت کنید:

    The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

    برای اصلاح این خطا، سیاست AssignMessage را تغییر دهید تا از <Set> برای تنظیم سرصفحه های CORS به جای <Add> استفاده کنید، همانطور که در گزیده زیر نشان داده شده است. برای اطلاعات بیشتر، به مقاله انجمن مربوطه مراجعه کنید.

    <AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

    خطا: درخواست فیلد سرصفحه مجاز نیست

    هنگام استفاده از این API را امتحان کنید، اگر خطای Request header field not allowed ، مشابه مثال زیر دریافت کردید، ممکن است لازم باشد سرصفحه های پشتیبانی شده در خط مشی CORS را به روز کنید. به عنوان مثال:

    Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
content-type is not allowed by Access-Control-Allow-Headers in preflight response

    در این مثال، باید هدر content-type به بخش Access-Control-Allow-Headers در خط مشی CORS AssignMessage خود اضافه کنید، همانطور که در پیوست کردن خط مشی افزودن CORS به یک پراکسی API جدید توضیح داده شده است.

    خطا: هنگام فراخوانی یک پراکسی API با استفاده از OAuth2، دسترسی ممنوع است

    خط‌مشی OAuthV2 Apigee یک پاسخ توکن را برمی‌گرداند که حاوی ویژگی‌های غیر منطبق با RFC است. برای مثال، این خط‌مشی به جای Bearer مورد انتظار مطابق با RFC، یک توکن با مقدار BearerToken برمی‌گرداند. این پاسخ token_type نامعتبر می‌تواند منجر به خطای Access denied هنگام استفاده از Try this API شود.

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