Accessing the Swagger Visualization Portal

Access the Swagger Visualization Portal on the API Catalog page.

Before you begin

1. Authorize the APIs and define a REST endpoint for the APIs that you want to view in the Swagger Visualization Portal.
2. Deploy the API to an Environment that has an runtime with an API Type set to Advanced in the Shared Web Server settings of Runtime Management in  Integration.

note

To avoid a "Failed to load specification" error, rename the default root node name of the imported JSON profiles in the Profile component.

Procedure

1. Go to the Configure APIs and Applications > Deployed APIs page.

   Your currently deployed API Service and API Proxy components appear.

2. Find the API Service component that you want to view the Swagger Visualization Portal for and click View in the Details column.

   The API slide-out panel opens.

3. Click on the REST tab and then click Access Swagger Visualization Portal.

4. Based on the Authentication Type set on your runtime in the Runtime Management > Shared Web Server panel of Integration, the following situations occur:

   • If no authentication (None) is set, the portal opens without requiring additional credentials.

   • If Basic authentication type is set and it specifies more than one user on the User Management tab of the Shared Web Server panel, enter your user name and password. Click Open.

   • If the External Provider type is set, select the desired credentials for API Contract, Application, and API Key. Click Open and enter your credentials set against your identity provider.

     A web proxy window for the External Provider setting opens, stating the receipt of the Authorization Code. Optionally, close this window to return to the Swagger Visualization Portal.

   • If you configure multiple authentication methods for an runtime, it uses the default authentication method configured in Shared Web Server settings.

Results

The Swagger Visualization Portal opens a new tab in your internet browser.