General Tab

Use the general tab to configure:

  • Portal Status

  • Portal Name

  • Portal URL

  • Logo

  • Favicon

  • OpenAPI Rendering

Portal Status

SwaggerHub Portal allows you to set one of the following statuses:

  • Portal online. This status means that you can access both the provider view and the consumer view. Both providers and consumers can access and navigate your published portal when it is online.

  • Portal offline. This status means that you can only access the provider view. Opening the consumer view returns an offline message. Providers and consumers cannot access your published portal when it is offline.

You can change the visibility status of your portal anytime.

Portal Name

The portal name is a unique name that is shown on all your portal pages.

Tip

Use a portal name that reflects the branding of your portal.

Portal URL

Caution

Changing the portal URL breaks links and bookmarks pointing to the portal.

The Portal URL is a unique web address used to access your published Portal.

The Portal URL consists of the following parts:

  • A domain, which is always the following: https://portal.swaggerhub.com/

  • A configurable subdomain, for example: petco

Example 1. Custom Portal URL for PetCo Portal

https://petco.portal.swaggerhub.com/



Tip

  • Provide a more branded experience for your consumers - learn how to create a custom domain name for your portal here.

  • Choose a descriptive subdomain name that reflects your organization's branding.

Favicon

The favicon is a small image that is shown in browser tabs and bookmark bars.

Property

Value

Horizontal Size

16 pixels

Vertical Size

16 pixels

File Format

  • ICO

  • GIF

  • PNG

Note

The image file size cannot be more than 5 MB.

OpenAPI Rendering

This setting allows you to choose how you want to render your OpenAPI definitions across all your products in SwaggerHub Portal.

You can choose:

  • Elements/SwaggerUI

  • Elements

  • SwaggerUI

If you choose Elements/SwaggerUI, you'll be able to switch between the two options using a toggle when viewing the API.

Note

You can generate code snippets in the Elements User Interface.

In this section:
© 2024
Publication date: