Création d'un déploiement pour une REST API API passerelle intégrée

Dans API Gateway, un REST API déploiement est représenté par une ressource de déploiement. C'est similaire à un exécutable d'un API qui est représenté par une RestApiressource.

Pour que le client vous appelleAPI, vous devez créer un déploiement et y associer une étape. Une étape est représentée par une ressource Stage. Il représente un aperçu des méthodesAPI, des intégrations, des modèles, des modèles de mappage et des autorisateurs Lambda (anciennement appelés autorisateurs personnalisés). Lorsque vous mettez à jour leAPI, vous pouvez le redéployer API en associant une nouvelle étape au déploiement existant. Nous aborderons la création d'une étape sous Configurer une scène pour un REST API in API Gateway.

Créer un déploiement

Les procédures suivantes montrent comment créer un déploiement pour un RESTAPI.

AWS Management Console

Vous devez en avoir créé un REST API avant de le déployer pour la première fois. Pour plus d’informations, consultez Développez REST APIs dans API Gateway.

La console API Gateway vous permet de déployer un API en créant un déploiement et en l'associant à un stage nouveau ou existant.

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

2. Dans le volet APIsde navigation, choisissez celui que API vous souhaitez déployer.

3. Dans le volet Ressources, sélectionnez Déployer 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, le AWS CLI AWS SDK, un ou le API Gateway REST API pour créer un déploiement.

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

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

Le n'APIest pas appelable 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>'

Lors API du premier déploiement, vous pouvez combiner la création de l'étape 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 fait dans les coulisses de la console API Gateway lorsque vous déployez une application pour API la première fois ou lorsque vous la redéployez API vers une nouvelle étape.

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

Prochaines étapes de votre API déploiement

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

Modifier les paramètres de scène

Une fois qu'un API est déployé, vous pouvez modifier les paramètres de l'étape pour activer ou désactiver le API cache, la journalisation ou la limitation des demandes. Vous pouvez également choisir un certificat client pour le backend afin d'authentifier API Gateway et définir des variables d'étape pour transmettre le contexte de déploiement à l'APIintégration lors de l'exécution. Pour plus d’informations, consultez Modifier les paramètres de scène.

Après avoir modifié les paramètres du stage, vous devez le redéployer API pour que les modifications prennent effet.

Note

Si les paramètres mis à jour, tels que l'activation de la journalisation, nécessitent un nouveau IAM rôle, vous pouvez ajouter le IAM rôle requis sans redéployer leAPI. Cependant, quelques minutes peuvent s'écouler avant que le nouveau IAM rôle ne prenne effet. Avant cela, les traces de vos API appels ne sont pas enregistrées, même si vous avez activé l'option de journalisation.

Choisissez différentes combinaisons d'étapes de déploiement

Étant donné qu'un déploiement représente un API instantané 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 manière dont les utilisateurs appellent les différentes versions du. API Cela est utile, par exemple, lorsque vous souhaitez revenir à un déploiement précédent ou fusionner une « branche privée » du API dans une branche API publique.

La procédure suivante montre comment procéder à l'aide de l'éditeur Stage dans la console API Gateway. Il est supposé que vous devez en avoir déployé un 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.

Transmettez les 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'APIintégration lors 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 Utiliser des variables d'étape pour un REST API in API Gateway.