Configuration des variables d'étape pour REST APIs dans API Gateway

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

Créez une API, puis créez une méthode GET sur la ressource racine de l’API. Définissez le type d’intégration sur HTTP et définissez URL du point de terminaison sur http://${stageVariables.url}.

Déployez l’API vers une nouvelle étape nommée beta.

Dans le volet de navigation principal, choisissez Étapes, puis sélectionnez l’étape bêta.

Dans l’onglet Variables d’étape, choisissez Modifier.

Choisissez Ajouter une variable d’étape.

Pour Nom, saisissez url. Pour Valeur, entrez httpbin.org/get.

Choisissez Ajouter une variable d’étape, puis procédez comme suit :

Pour Nom, saisissez stageName. Pour Valeur, entrez beta.

Choisissez Ajouter une variable d’étape, puis procédez comme suit :

Pour Nom, saisissez function. Pour Valeur, entrez HelloWorld.

Choisissez Save (Enregistrer).

Créez maintenant une deuxième étape. Dans le volet de navigation Étapes, choisissez Créer une étape. Sous Stage name (Nom de l’étape), entrez prod. Sélectionnez un déploiement récent dans Déploiement, puis choisissez Créer une étape.

Comme pour l’étape bêta, définissez les trois variables d’étape (url, stageName et function) sur des valeurs différentes (petstore-demo-endpoint.execute-api.com/petstore/pets, prod et HelloEveryone) respectivement.

Dans le volet de navigation Stages, sélectionnez beta. Sous Détails de l’étape, choisissez l’icône de copie pour copier l’URL d’invocation de votre API, puis saisissez l’URL d’invocation de votre API dans un navigateur web. Cela lance la demande GET de l’étape beta sur la ressource racine de l’API.

La réponse renvoyée par la demande GET à l’étape beta est présentée ci-dessous. Vous pouvez également vérifier le résultat en utilisant un navigateur pour accéder à l’adresse http://httpbin.org/get. Cette valeur a été affectée à la variable url à l’étape beta. Les deux réponses sont identiques.

Dans le volet de navigation Stages, sélectionnez l’étape prod. Sous Détails de l’étape, choisissez l’icône de copie pour copier l’URL d’invocation de votre API, puis saisissez l’URL d’invocation de votre API dans un navigateur web. Cela lance la demande GET de l’étape prod sur la ressource racine de l’API.

La réponse renvoyée par la demande GET à l’étape prod est présentée ci-dessous. Vous pouvez vérifier le résultat en utilisant un navigateur pour accéder à http ://petstore-demo-endpoint.execute-api. com/petstore/pets. Cette valeur a été affectée à la variable url à l’étape prod. Les deux réponses sont identiques.

Dans le volet de navigation Resource, sélectionnez la méthode GET.

Pour ajouter un paramètre de chaîne de requête à l’URL de la méthode, sélectionnez l’onglet Demande de méthode, puis dans la section Paramètres de la demande de méthode, choisissez Modifier.

Choisissez Paramètres de chaîne de requête d’URL et procédez comme suit :

1. Sélectionnez Add query string (Ajouter une chaîne de requêtes).

2. Pour Nom, saisissez stageName.

3. Gardez Obligatoire et Mise en cache désactivés.

Choisissez Save (Enregistrer).

Choisissez l’onglet Demande d’intégration, puis dans la section Paramètres de la demande d’intégration, sélectionnez Modifier.

Pour URL du point de terminaison, ajoutez ?stageName=${stageVariables.stageName} à la valeur d’URL définie précédemment, de sorte que l’URL du point de terminaison soit http://${stageVariables.url}?stageName=${stageVariables.stageName}.

Choisissez Déployer l’API et sélectionnez l’étape bêta.

Dans le volet de navigation principal, choisissez Étapes. Dans le volet de navigation Stages, sélectionnez beta. Sous Détails de l’étape, choisissez l’icône de copie pour copier l’URL d’invocation de votre API, puis saisissez l’URL d’invocation de votre API dans un navigateur web.

Vous recevez la réponse suivante. Notez que la valeur beta, affectée à la variable d’étape stageName, est transmise au backend en tant qu’argument stageName.

Créez une fonction Lambda nommée HelloWorld à l’aide de l’exécution Node.js par défaut. Le code doit contenir ce qui suit :

export const handler = function(event, context, callback) {
    if (event.stageName)
        callback(null, 'Hello, World! I\'m calling from the ' + event.stageName + ' stage.');
    else
        callback(null, 'Hello, World! I\'m not sure where I\'m calling from...');
};

Pour plus d’informations sur la création d’une Fonction Lambda, consultez Bien démarrer avec la console d’API REST.

Dans le volet Ressources, sélectionnez Créer une ressource, puis procédez comme suit :

1. Pour Chemin de ressources, sélectionnez /.

2. Sous Resource Name (Nom de la ressource), entrez lambdav1.

3. Choisissez Créer une ressource.

Sélectionnez la ressource /lambdav1, puis choisissez Créer une méthode.

Ensuite, procédez comme suit :

1. Pour Type de méthode, sélectionnez GET.

2. Pour Type d’intégration, sélectionnez Fonction Lambda.

3. Maintenez Intégration proxy Lambda désactivée.

4. Sous Lambda function (Fonction Lambda), saisissez ${stageVariables.function}.

   

   Astuce

   Lorsque vous y êtes invité avec la commande Ajouter une autorisation, copiez-la. Exécutez la commande sur chaque Fonction Lambda qui sera affectée à la variable d’étape function. Par exemple, si la valeur $stageVariables.function est HelloWorld, exécutez la commande AWS CLI suivante :

   aws lambda add-permission --function-name arn:aws:lambda:us-east-1:account-id:function:HelloWorld --source-arn arn:aws:execute-api:us-east-1:account-id:api-id/*/GET/lambdav1 --principal apigateway.amazonaws.com --statement-id statement-id-guid --action lambda:InvokeFunction

   Si vous ne le faites pas, l’appel de la méthode renverra une réponse 500 Internal Server Error. Remplacez ${stageVariables.function} par le nom de la Fonction Lambda qui est affectée à la variable d’étape.

   

5. Choisissez Créer une méthode.

Déployez l’API dans les étapes prod et beta.

Dans le volet de navigation principal, choisissez Étapes. Dans le volet de navigation Stages, sélectionnez beta. Sous Détails de l’étape, choisissez l’icône de copie pour copier l’URL d’invocation de votre API, puis saisissez l’URL d’invocation de votre API dans un navigateur web. Ajoutez /lambdav1 à l’URL avant d’appuyer sur Entrée.

Vous recevez la réponse suivante.

"Hello, World! I'm not sure where I'm calling from..."

Sélectionnez la ressource /lambdav1, puis choisissez Créer une méthode.

Ensuite, procédez comme suit :

1. Pour Type de méthode, sélectionnez POST.

2. Pour Type d’intégration, sélectionnez Fonction Lambda.

3. Maintenez Intégration proxy Lambda désactivée.

4. Sous Lambda function (Fonction Lambda), saisissez ${stageVariables.function}.

5. Lorsque vous y êtes invité avec la commande Ajouter une autorisation, copiez-la. Exécutez la commande sur chaque Fonction Lambda qui sera affectée à la variable d’étape function.

6. Choisissez Créer une méthode.

Choisissez l’onglet Demande d’intégration, puis dans la section Paramètres de la demande d’intégration, sélectionnez Modifier.

Choisissez Modèles de mappage, puis choisissez Ajouter un modèle de mappage.

Pour Type de contenu, entrez application/json.

Pour Corps du modèle, entrez le modèle suivant :

#set($inputRoot = $input.path('$'))
{
    "stageName" : "$stageVariables.stageName"
}

Choisissez Save (Enregistrer).

Déployez l’API dans les étapes beta et prod.

Pour utiliser un client d’API REST afin de transmettre des métadonnées spécifiques à l’étape, procédez comme suit :

1. Dans le volet de navigation Stages, sélectionnez beta. Sous Détails de l’étape, choisissez l’icône de copie pour copier l’URL d’invocation de votre API, puis entrez l’URL d’invocation de votre API dans le champ d’entrée d’un client d’API REST. Ajoutez /lambdav1 avant de soumettre votre demande.

   Vous recevez la réponse suivante.

   "Hello, World! I'm calling from the beta stage."

2. Dans le volet de navigation Étapes, choisissez prod. Sous Détails de l’étape, choisissez l’icône de copie pour copier l’URL d’invocation de votre API, puis entrez l’URL d’invocation de votre API dans le champ d’entrée d’un client d’API REST. Ajoutez /lambdav1 avant de soumettre votre demande.

   Vous recevez la réponse suivante.

   "Hello, World! I'm calling from the prod stage."

Pour utiliser la fonctionnalité Test afin de transmettre des métadonnées spécifiques à l’étape, procédez comme suit :

1. Dans le volet de navigation Ressources, choisissez l’onglet Test. Vous devrez peut-être choisir la flèche droite pour afficher l’onglet.

2. Pour function, entrez HelloWorld.

3. Pour stageName, entrez beta.

4. Sélectionnez Tester). Vous n’avez pas besoin d’ajouter de corps à votre demande POST.

   Vous recevez la réponse suivante.

   "Hello, World! I'm calling from the beta stage."

5. Vous pouvez répéter les étapes précédentes pour tester l’étape Prod. Pour stageName, entrez Prod.

   Vous recevez la réponse suivante.

   "Hello, World! I'm calling from the prod stage."