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

Exemples d'utilisation de Talend Cloud API Designer

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend API Designer
task
Création et développement > Création d'APIs

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

Avant de commencer

Procédure

  1. 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
  2. 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
    • AT

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