Création d’un déploiement pour une API REST dans API Gateway

Dans API Gateway, le déploiement d’une API REST est représenté par une ressource Deployment. Il est similaire à un exécutable d’une API qui est représentée par une ressource RestApi.

Pour que le client appelle l’API, vous devez créer un déploiement et y associer une étape. Une étape est représentée par une ressource Stage. Elle représente un instantané de l’API, y compris les méthodes, les intégrations, les modèles, les modèles de mappage et les mécanismes d’autorisation Lambda (anciennement appelés mécanismes d’autorisation personnalisés). Lorsque vous mettez à jour l’API, vous pouvez redéployer l’API en associant une nouvelle étape au déploiement existant. Nous aborderons la création d’une étape sous Configuration d’une étape pour une API REST dans API Gateway.

Créer un déploiement

Les procédures suivantes montrent comment créer un déploiement pour une API REST.

AWS Management Console

Vous devez avoir créé une API REST avant de la déployer pour la première fois. Pour en savoir plus, consultez Développement d’API REST dans API Gateway.

La console API Gateway vous permet de déployer une API en créant un déploiement et en l’associant à une étape nouvelle ou existante.

1. Connectez-vous à la console API Gateway à l’adresse https://console.aws.amazon.com/apigateway.

2. Dans le volet de navigation APIs, sélectionnez l’API que vous souhaitez déployer.

3. Dans le volet Resources, sélectionnez Deploy API.

4. Pour Étape, sélectionnez l’une des options suivantes :

   1. Pour créer une nouvelle étape, sélectionnez Nouvelle étape, puis entrez un nom dans Nom de l’étape. Vous pouvez éventuellement fournir une description du déploiement dans Description du déploiement.

   2. Pour choisir une étape existante, sélectionnez le nom de l’étape dans le menu déroulant. Vous pouvez également fournir une description du nouveau déploiement dans Description du déploiement.

   3. Pour créer un déploiement qui n’est pas associé à une étape, sélectionnez Aucune étape. Plus tard, vous pourrez associer ce déploiement à une étape.

5. Choisissez Deploy (Déployer).

AWS CLI

Lorsque vous créez un déploiement, vous instanciez la ressource Deployment. Vous pouvez utiliser la console API Gateway, l’AWS CLI, un kit AWS AWS ou l’API REST API Gateway pour créer un déploiement.

Pour utiliser la CLI afin de créer un déploiement, utilisez la commande create-deployment :

 aws apigateway create-deployment --rest-api-id <rest-api-id> --region <region>

L’API ne peut pas être appelée tant que vous n’associez pas ce déploiement à une étape. Si l’étape existe déjà, remplacez la propriété deploymentId correspondante par l’ID du déploiement que vous venez de créer (<deployment-id>).

 aws apigateway update-stage --region <region> \
    --rest-api-id <rest-api-id> \ 
    --stage-name <stage-name> \ 
    --patch-operations op='replace',path='/deploymentId',value='<deployment-id>'

Lorsque vous déployez une API pour la première fois, vous pouvez combiner l’étape de création et la création du déploiement en même temps :

 aws apigateway create-deployment --region <region> \
    --rest-api-id <rest-api-id> \
    --stage-name <stage-name>

C’est ce qui se produit en arrière-plan dans la console API Gateway, lorsque vous déployez une API pour la première fois ou lorsque vous redéployez l’API en l’intégrant à une nouvelle étape.

Pour redéployer une API, exécutez les mêmes étapes. Vous pouvez réutiliser la même étape autant de fois que vous le souhaitez.

Prochaines étapes pour le déploiement de votre API

Les prochaines étapes pour le déploiement de votre API sont les suivantes.

Modification des paramètres d’étape

Une fois qu’une API est déployée, vous pouvez modifier les paramètres d’étape pour activer ou désactiver le cache API, la journalisation ou les limitations de demande. Vous pouvez également choisir un certificat client pour que le backend authentifie API Gateway et définisse des variables d’étape afin de transmettre le contexte de déploiement à l’intégration d’API au moment de l’exécution. Pour plus d’informations, consultez Modification des paramètres d’étape.

Après avoir modifié les paramètres d’étape, vous devez redéployer l’API pour que les modifications prennent effet.

Note

Si les paramètres mis à jour, par exemple, l’activation de la journalisation, nécessitent un nouveau rôle IAM, vous pouvez ajouter le rôle IAM requis sans redéployer l’API. Cependant, cela peut prendre quelques minutes avant que le nouveau rôle IAM prenne effet. Avant cela, les traces de vos appels d’API ne sont pas consignées, même si vous avez activé l’option de journalisation.

Choix de différentes combinaisons d’étapes de déploiement

Étant donné qu’un déploiement représente un instantané d’API et qu’une étape définit un chemin vers un instantané, vous pouvez choisir différentes combinaisons d’étapes de déploiement pour contrôler la façon dont les utilisateurs appellent différentes versions de l’API. Cela s’avère utile, par exemple, lorsque vous voulez restaurer l’état de l’API à un déploiement antérieur ou fusionner une branche « privée » de l’API dans une branche publique.

La procédure suivante montre comment procéder à l’aide de l’éditeur Stage Editor (Éditeur d’étape) dans la console API Gateway. Nous supposons que vous devez avoir déployé une API plusieurs fois.

1. Si vous n’êtes pas déjà dans le volet Étapes, dans le panneau de navigation principal, choisissez Étapes.

2. Sélectionnez l’étape que vous souhaitez mettre à jour.

3. Sous l’onglet Historique de déploiement, sélectionnez le déploiement que vous voulez que l’étape utilise.

4. Choisissez Modifier le déploiement actif.

5. Confirmez que vous souhaitez changer le déploiement actif et choisissez Modifier le déploiement actif dans la boîte de dialogue Rendre le déploiement actif.

Transmission des données spécifiques au déploiement à votre API.

Pour un déploiement, vous pouvez définir ou modifier des variables d’étape pour transmettre des données spécifiques au déploiement à l’intégration d’API au moment de l’exécution. Vous pouvez effectuer cette opération dans l’onglet Stage Variables dans l’éditeur Stage Editor. Pour plus d’informations, consultez les instructions dans Utilisation de variables d’étape pour une API REST dans API Gateway.