Exporter une définition d'API

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

Vous avez une API dans Talend Cloud API Designer.
Vous avez généré un jeton d'accès personnel. Pour plus d'informations, consultez Générer un jeton d'accès personnel.

Procédure

Ouvrez Talend Cloud API Tester et créez une requête.

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 Accéder aux applications 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.

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 Accéder aux applications 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.

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`. Note InformationsRemarque : 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é.

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é.

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.

Note InformationsConseil : 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.
Une fois votre requête configurée, cliquez sur Send.
Exemple

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.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici