Enable Live Documentation for your API - Cloud

Talend Cloud API Designer Getting Started Guide
Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
Last publication date
2024-01-22
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.