Importer une définition d'API sur AWS API Gateway - Cloud

Exemples d'utilisation de Talend Cloud API Designer

Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Content
Création et développement > Création d'APIs
Last publication date
2024-03-06

Importez une définition d'API au format JSON sur AWS API Gateway.

Avant de commencer

  • Vous avez accès à AWS API Gateway.
  • Vous avez installé AWS CLI. Pour plus d'informations, consultez Installation de l'AWS CLI.
  • Vous avez exporté votre définition d'API au format JSON.

Procédure

  1. Ouvrez une invite de commande et entrez la commande suivante afin de charger le fichier :
    aws apigateway import-rest-api [--parameters endpointConfigurationTypes={type}] --body 'file://{yourfile}.json'
  2. Ajoutez les paramètres adéquats :
    Paramètre Description
    {type} Facultatif. Définit le type d'endpoint à utiliser. La valeur peut être :
    • EDGE pour une configuration d'API optimisée pour les périphériques, particulièrement adaptée aux applications mobiles (valeur par défaut)
    • REGIONAL pour un endpoint d'API régional
    • PRIVATE pour une API privée
    {yourfile} Chemin et nom du fichier de la définition d'API exportée.
  3. Exécutez la commande.

Résultats

Votre API est exportée et l'invite de commande retourne des informations sur l'API, comme son ID, qui peut-être utilisée pour mettre à jour la définition. Vous pouvez vérifier votre définition d'API dans la console d'AWS API Gateway.

Définition de l'API dans la console AWS API Gateway.

Pour plus d'informations concernant la commande import-rest-api, consultez la documentation AWS (en anglais).