Skip to main content

How To Onboard An Application Using SwaggerHub API Gateway

Prerequisites​

  • APIsec platform needs API Key to connect with SwaggerHub Cloud

    • Follow the steps below to obtain API Key

      • Click on Profile Icon Choose the SwaggerHub Gateway
      • Select API Key and Copy API Key Choose the SwaggerHub Gateway

  • APIsec platform needs API Key and Server URL to connect with SwaggerHub On-premises

    • Follow the above steps to get the API Key.
    • Set up the server address, complete the on-premise installation, and then use it as the SwaggerHub Server URL.

Open your browser and visit: https://<your-tenant>.apisecapps.com

Start Adding a New Application​

Click on the "Add Application" button.

Add Application

Select SwaggerHub Gateway​

  • Choose the "SwaggerHub Gateway" option. Choose the SwaggerHub Gateway

  • Click "Next" to proceed. Click Next

  • Click "New Connection" alt text

Enter Application Details​

  • Fill the Form Name, Organization Name, Auth Type, Auth details. alt text

  • Click "Test Connection" alt text

    Test Connection Success alt text

  • Click "Create Connection" alt text

  • Click "Onboard Application" alt text

  • Click and Select All API's alt text

  • Select correct API alt text

  • Click "Continue" alt text

  • Select endpoints alt text

  • Click "Onboard" alt text

  • Application creation Success Message alt text

  • SwaggerHub API Integration Dashboard alt text

Auto-Onboard​

The Auto-Onboard feature streamlines API onboarding by automatically detecting and registering unregistered APIs from SwaggerHub Gateway. This ensures that all APIs, including newly published ones, are consistently onboarded and tested for vulnerabilities with minimal manual effort.

Enable Auto-onboard​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    alt text

  • Click Onboard Applications adjacent to the SwaggerHub

    alt text

  • Enable Auto-Onboard of any existing SwaggerHub connection.

    alt text

  • Fill the AWS AutoOnboard Details and click on Save Schedule

    • Frequency – How often the onboarding should occur. By default it is weekly.
    • Day of the Week – Select the specific day for onboarding.
    • Hour – The exact time (in hours and minutes) when the onboarding should start.
    • Timezone – The timezone in which the schedule should be applied
    • Organization - Select Organization. If the selected organization has no projects then all APIs from that organization will be automatically selected for auto-onboarding
    • API Selection Scope - Select whether to auto-onboard all available APIs or limit onboarding to only those published after the specified date.

    alt text

    • Successfully saved auto-onboard details

    alt text

Update Schedule​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    alt text

  • Click Onboard Applications adjacent to the SwaggerHub

    alt text

  • Click Auto-Onboard

    alt text

  • Update the details and Click on Update Schedule

    alt text

Disable Auto-Onboard​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    alt text

  • Click Onboard Applications adjacent to the SwaggerHub

    alt text

  • Click Auto-Onboard

    alt text

  • In Edit SwaggerHub AutoOnboard Details, disable the Enable Automatic API Onboarding.

    alt text

  • Click Yes alt text

  • Auto-Onboard details deleted successfully!

    alt text