Accéder au contenu principal Passer au contenu complémentaire

Mettre à jour une définition d'API sur AWS API Gateway

Importez un fichier JSON sur AWS API Gateway pour mettre à jour une définition existante.

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.
  • Vous avez importé une version précédente de la définition d'API sur AWS API Gateway.

Procédure

  1. Ouvrez une invite de commande et entrez la commande suivante afin de charger le fichier : 
    aws apigateway put-rest-api --rest-api-id {api-id} --mode {mode} --body 'file://{yourfile}.json'
  2. Ajoutez les paramètres adéquats :
    Paramètre Description
    {api-id} ID de l'API à mettre à jour dans AWS API Gateway.
    {mode} Comportement à l'import. La valeur peut être overwrite pour écraser la version précédente de l'API avec la nouvelle, ou merge pour fusionner les deux versions.
    {yourfile} Chemin et nom du fichier de la définition d'API exportée.
  3. Exécutez la commande.

Résultats

Votre définition d'API est fusionnée ou écrasée, selon le mode défini. Vous pouvez vérifier la mise à jour dans la console d'AWS API Gateway.

Dans cette exemple, une première version de la définition, ne contenant que la ressource /contacts et ses opérations, a été importée. Puis, une seconde version avec la ressource/companies a été importée et fusionnée avec la version précédente.

Capture d'écran de la définition d'API fusionnée.

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

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