Preview
You can preview your changes in your portal before you publish them. The SwaggerHub Portal offers the following preview modes based on your location within it:
Portal Configuration
Product Settings
Product Content
This video demonstrates how preview works in SwaggerHub Portal:
Read the descriptions below to learn about their differences.
Portal Configuration
This mode allows you to preview your portal in terms of configurations you have made in the following tabs:
General settings
Appearance
Landing page
Click Preview in the top bar next to Live View to see your changes. The Portal will open a new browser tab with values from the tabs above.
Note
This landing page preview mode only displays new products if they are already published. In this mode, you can't navigate to other products or use the search function.
This preview mode shows the offline state if the Portal online setting is toggled off.
Read more about Portal Configuration here.
Product Settings
This mode allows a live preview of the product tile on the landing page.
When you open the product settings in your portal, there is a preview of the product tile next to the configuration panel. Any changes you make in the panel appear in this preview as soon as you make them.
Note
Private products have two previews: for a logged-in and logged-out state.
Read more about Product Settings here.
Product Content
This mode allows you to preview the content of a specific product, for example, its pages or APIs. Note that you can only preview the content of one product at a time.
Click Preview in the top bar next to Live View to see your changes. This opens a new browser tab with the product in context.
Note
In this mode, you can't navigate to other products, the landing page, or search.
Preview in this mode shows content even if your Portal is in an offline state.
Read more about Product Content here.
Resolved State
The APIs in the provider view of SwaggerHub Portal are in an unresolved state. The API is in a resolved state after a Preview or Publish action. A resolved state means that the APIs also show:
Contents of external references, if there are external references in the API.
Domains information, if domains are referenced in the API in SwaggerHub.