Exporting a definition for an API gateway - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
Last publication date
2024-01-25
Export an API definition compatible with AWS API Gateway or Azure API Management.

Procedure

  1. Open the API version that you want to export.
  2. Click Export.
  3. Click OpenAPI Specification and select AWS API Gateway or Azure API Management.
    If you want to export your API for another gateway, Apigee for example, it is recommended to select Standard OAS.
  4. Select the OAS version and format.
    Since Talend extensions are not supported by API gateways, No extensions is selected by default and cannot be modified.
    Export API dialog box.
  5. If you do not want to export your entire API, click Filter export and select the operations that you want to export.

    When you filter your export, all data types, components, and resources are exported, regardless of the operations you selected.

    Note:
    Resources are exported even if they contain no operations or if their operations are filtered out. For example, in the image below, all operations in the /contact/{contactid} resource are filtered out, but the path still appears in the exported file:
    "/contacts/{contactid}" : {
          "parameters" : [ {
            "$ref" : "#/components/parameters/contactid"
          } ]
        }

    AWS API Gateway shows a warning when importing a file containing paths with no operations, but it does not prevent the import.

    Export API dialog box.
  6. Click Export.