Récupérer une définition d'API pour AWS API Gateway

Exportez une définition d'API au format JSON compatible avec AWS API Gateway depuis Talend Cloud API Designer.

Avant de commencer

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

Procédure

Ouvrez une invite de commande et entrez la commande suivante afin d'exporter votre définition d'API.

curl --header "Authorization:Bearer {userToken}" -X GET -o {outFile}.json https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}?format=OpenApi3Aws

Ajoutez les paramètres adéquats :

Paramètre	Description
{userToken}	Jeton généré depuis Talend Cloud.
{outFile}	Chemin d'accès et nom du fichier de votre définition d'API. Par exemple : contactsapi.json.
{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.

Exécutez la commande.

Résultats

Votre définition d'API est exportée au format JSON compatible avec AWS API Gateway et sauvegardée dans le répertoire sélectionné.

Pour plus d'informations concernant l'export d'une définition d'API avec un mode de compatibilité API Gateway, consultez le Guide d'utilisation de Talend Cloud API Designer.

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