Enabling live API documentation - Cloud

Talend Cloud API Services Platform Getting Started Guide

Version
Cloud
Language
English
Operating system
API Services Platform
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Management Console
Talend Studio
Content
Design and Development
Last publication date
2024-03-05

Generate a live preview of your API documentation.

Procedure

  1. Open your API definition in Talend Cloud API Designer.
  2. Click Settings at the top of the left panel.
  3. In the LIVE DOCUMENTATION section, toggle the Enabled button to On.
  4. Enter a URL for your documentation.
    The documentation URL must be unique. You can enter moviecatalog-<your company name> for example.
  5. Select the Visibility of the documentation, Public for example.
    LIVE DOCUMENTATION section.
  6. Click Save.

Results

Your live documentation is now enabled and available to anyone with the URL you defined.