Publishing downloadable API definitions - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs

Provide your API definition as an OAS 3.0 or Swagger 2.0 file that your users can download from your portal.

Procedure

  1. In the API Portal tab, click the Settings button.
  2. In the API DEFINITION DOWNLOAD section, select the formats that you want to publish with your documentation.
  3. Click Back to return to the list of APIs and publish an API version.

Results

Once your API is published and your portal is deployed, a Download button appears. If you have only selected one of the formats, you have either a Download OAS 3 or Download Swagger 2 button. If you have selected both, you have a drop-down list that allows you to select the format to download.