Skip to main content Skip to complementary content
Announcements

Enable Live Documentation for your API

Enable the Live Documentation to generate a preview of your API documentation.

Procedure

  1. Click the Settings button.
  2. Under LIVE DOCUMENTATION, toggle the Enabled button to On.
  3. Enter a subdomain name for your Live Documentation.

    Example

    Example of a live documentation definition.
  4. Set the visibility, Team in this example, then click Save.

Results

Once the Live Documentation is enabled, you can click the Open link that appears to the right of the URL field to see the preview.

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 – let us know how we can improve!

Leave your feedback here