Skip to main content
Skip table of contents

SwaggerHub Sync

Apiboost has introduced a powerful new add-on feature that enables seamless synchronization of API documentation from SwaggerHub. This SwaggerHub sync add-on allows users to directly import API documentation into Apiboost, streamlining the process of keeping API documentation consistent and up-to-date across platforms.

Key features of this integration include:

  • Direct import of API documentation from SwaggerHub

  • Real-time updates and synchronization using lightweight webhooks

  • Bulk import functionality for efficient initial setup

  • Support for personal and organizational SwaggerHub accounts

  • Versioning support to prevent creation of duplicate documents [Roadmap]

By leveraging this integration, Apiboost administrators can continue to use the robust API Documentation and schema validation of SwaggerHub without managing API Specifications in multiple Developer Portals or having to manage multiple user instances and permission systems. Additionally, it helps to link API Documentation with the API Products you are using in Apiboost to promote visibility and adoption of your APIs. This helps to save time, ensure consistency in your documentation, and simplify the API management workflow.

Connecting SwaggerHub with Apiboost

  1. Log in to your SwaggerHub instance with an administrator account.

  2. In top right corner of UI, click the Account icon and click API Key

  3. Next to API Key, click Copy

  4. Navigate to your Apiboost Developer Portal and log in as a SaaS Administrator.

    Mosaic macros cannot be exported to this format.

  5. In Apiboost Admin navigation, expand Integrations and click SwaggerHub.

  6. On the SwaggerHub configuration page, paste your API Key and click Save.

  7. After you have entered your API Key into the field and saved the form, you can now select which Organizations you would like to allow for administrators to retrieve and sync API Documentation from in SwaggerHub.

🥳 Congratulations! You’ve successfully connected Apiboost to your SwaggerHub instance.

Next Steps:

Mosaic macros cannot be exported to this format.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.