Skip to main content Skip to complementary content

Enabling the Live Documentation

In order to share your API documentation with people who are not in your team, you need to enable the Live Documentation feature.

Until it is enabled, it is only viewable as a preview for users who have access to the API definition, as indicated on the Live Documentation button in the header.

Live Documentation button in the header.

Procedure

  1. Go to the Settings page.
    You can access this page by going to Edit > Settings or by clicking Settings in the left panel.
  2. Toggle the Enabled button from Off to On and enter a URL.
    Live documentation configuration.
  3. Choose the visibility. If you select Password protected, enter a password in the corresponding field.
  4. Click Save to enable your Live Documentation.

Results

Your Live Documentation is now available. You can click Open to open it in a new tab.

Screenshot of the Petstore API live documentation.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here