Exporter une définition d'API - Cloud

Guide d'utilisation des API Talend Cloud
Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Création et développement > Création d'APIs
Création et développement > Test d'API
Last publication date
2024-04-04

Afin d'exporter une définition d'API depuis Talend Cloud API Designer, utilisez la méthode GET sur l'endpoint /api-definitions/{id}.

Pour des cas d'usage utilisant cette requête, consultez Exemples d'utilisation de Talend Cloud API Designer.

Avant de commencer

Procédure

  1. Ouvrez Talend Cloud API Tester et créez une requête.
  2. Conserver la méthode GET sélectionnée par défaut, puis saisissez l'URI ci-dessous avec les paramètres appropriés :
    https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}
    Paramètre Description
    {region} Région de votre compte Talend Cloud. La valeur peut être :
    • us-west
    • us
    • eu
    • ap
    • au

    Pour plus d'informations, consultez URL et régions de Talend Cloud.
    {api-id} ID de la version de l'API à récupérer. Pour le récupérer, ouvrez votre API dans Talend Cloud API Designer et allez dans Settings > MANAGEMENT API ou utilisez la méthode GET sur l'endpoint /api-definitions pour obtenir une liste de définitions d'API avec leur ID.
  3. Facultatif : Développez QUERY PARAMETERS et cliquez sur Add query parameters.
    Les paramètres disponibles sont les suivants :
    Paramètre Description
    format Format dans lequel vous souhaitez exporter votre définition. La valeur peut être :
    • OpenApi3 (valeur par défaut)
    • Swagger20
    • Swagger12
    • Raml10
    • Raml08
    • OpenApi3Aws (format compatible avec AWS API Gateway)
    • Swagger20Azure (format compatible avec Azure API Management)
    talendExtensions Indique si vous souhaitez que vôtre définition exportée contienne des extensions ou des annotations Talend. Sa valeur peut être true ou false. La valeur par défaut est false.
    Remarque : Les extensions Talend ne sont compatibles ni avec AWS API Gateway, ni avec Azure API Management. Si vous avez saisi OpenApi3AWS ou Swagger20Azure dans le paramètre format, ce paramètre-ci est ignoré.
  4. Cliquez sur le bouton Add header, saisissez Authorization dans le champ name et Bearer suivi d'un espace, puis de votre jeton, dans le champ value.
    Conseil : Dans Talend Cloud API Tester, vous pouvez ajouter votre jeton comme variable d'environnement privée et y faire référence dans vos requêtes, à l'aide de l'Expression Builder. Pour plus d'informations, consultez Utiliser des environnements.
  5. Une fois votre requête configurée, cliquez sur Send.

    Exemple

    Dans Talend Cloud API Tester, la requête est configurée.

Résultats

Talend Cloud API Tester renvoie une réponse contenant la définition de l'API dans le format sélectionné. Vous pouvez alors cliquer sur le bouton Download situé en bas de page afin de l'enregistrer.
Bouton Download (Télécharger) en bas à droite de la page.