Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Commencez à utiliser la REST API console
Dans cet exercice de démarrage, vous allez créer un serveur sans serveur à REST API l'aide de la REST API console API Gateway. Le mode APIs Serverless vous permet de vous concentrer sur vos applications au lieu de perdre votre temps à approvisionner et à gérer des serveurs. Cet exercice devrait prendre moins de 20 minutes et peut être réalisé avec l'offre gratuite AWS
Vous commencez par créer une fonction Lambda à l'aide de la console Lambda. Ensuite, vous créez un REST API à l'aide de la REST API console API Gateway. Ensuite, vous créez une API méthode et vous l'intégrez à une fonction Lambda à l'aide d'une intégration de proxy Lambda. Enfin, vous déployez et invoquez votreAPI.
Lorsque vous invoquez votre RESTAPI, API Gateway achemine la demande vers votre fonction Lambda. Lambda exécute la fonction et renvoie une réponse à API Gateway. APIGateway vous renvoie ensuite cette réponse.
Pour effectuer cet exercice, vous avez besoin d'un utilisateur Compte AWS et d'un AWS Identity and Access Management (IAM) ayant accès à la console. Pour de plus amples informations, veuillez consulter Configuration pour utiliser API Gateway.
Rubriques
Étape 1 : Créer une fonction Lambda
Vous utilisez une fonction Lambda pour le backend de votre. API Lambda exécute le code uniquement lorsque cela est nécessaire et se met à l'échelle automatiquement, qu'il s'agisse de quelques requêtes par jour ou de milliers de requêtes par seconde.
Pour cet exercice, vous utilisez une fonction Node.js par défaut dans la console Lambda.
Pour créer une fonction Lambda
-
Sélectionnez Create function (Créer une fonction).
-
Sous Informations de base, pour Nom de la fonction, entrez
my-function
. Pour toutes les autres options, utilisez le paramètre par défaut.
-
Sélectionnez Create function (Créer une fonction).
Le code de la fonction Lambda par défaut devrait ressembler à ce qui suit :
export const handler = async (event) => { const response = { statusCode: 200, body: JSON.stringify('The API Gateway REST API console is great!'), }; return response; };
Vous pouvez modifier votre fonction Lambda pour cet exercice, à condition que la réponse de la fonction corresponde au format requis par Gateway. API
Remplacez le corps de réponse par défaut (Hello from Lambda!
) par The API Gateway REST API
console is great!
. Lorsque vous invoquez l'exemple de fonction, il renvoie une réponse 200
aux clients, ainsi que la réponse mise à jour.
Étape 2 : Création d'un REST API
Ensuite, vous créez un REST API avec une ressource racine (/
).
Pour créer un REST API
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.
-
Effectuez l’une des actions suivantes :
-
Pour créer votre premierAPI, pour RESTAPI, choisissez Build.
-
Si vous en avez déjà créé unAPI, choisissez Create API, puis Build for RESTAPI.
-
-
Pour APIle nom, entrez
my-rest-api
. (Facultatif) Sous Description, entrez une description.
Conservez le type de API point de terminaison défini sur Régional.
Choisissez Créer API.
Étape 3 : Créer une intégration de proxy Lambda
Ensuite, vous créez une API méthode pour votre REST API ressource racine (/
) et vous l'intégrez à votre fonction Lambda à l'aide d'une intégration par proxy. Dans une intégration de proxy Lambda, API Gateway transmet la demande entrante du client directement à la fonction Lambda.
Pour créer une intégration de proxy Lambda
-
Sélectionnez la ressource
/
, puis choisissez Créer une méthode. -
Pour Type de méthode, sélectionnez
ANY
. -
Pour Type d'intégration, sélectionnez Lambda
-
Activez Intégration de proxy Lambda.
-
Pour Fonction Lambda, entrez
my-function
, puis sélectionnez votre fonction Lambda. -
Choisissez Créer une méthode.
Étape 4 : Déployez votre API
Ensuite, vous créez un API déploiement et vous l'associez à une étape.
Pour déployer votre API
Choisissez DeployAPI (Déployer).
Pour Étape, sélectionnez Nouvelle étape.
Sous Stage name (Nom de l'étape), entrez
Prod
.(Facultatif) Sous Description, entrez une description.
Choisissez Deploy (Déployer).
Les clients peuvent désormais appeler votreAPI. Pour tester le vôtre API avant de le déployer, vous pouvez éventuellement choisir la ANYméthode, accéder à l'onglet Test, puis sélectionner Test.
Étape 5 : Invoquez votre API
Pour invoquer votre API
-
Dans le panneau de navigation principal, choisissez Étape.
-
Sous Détails de l'étape, cliquez sur l'icône de copie pour copier votre API appelURL.
-
Entrez l'invocation URL dans un navigateur Web.
L'intégralité URL devrait ressembler à
https://
.abcd123
.execute-api.us-east-2
.amazonaws.com/ProdVotre navigateur envoie une
GET
demande auAPI. -
Vérifiez votre API réponse. Vous devriez voir le texte
"The API Gateway REST API console is great!"
dans votre navigateur.
(Facultatif) Étape 6 : nettoyer
Pour éviter de vous faire supporter des coûts inutiles Compte AWS, supprimez les ressources que vous avez créées dans le cadre de cet exercice. Les étapes suivantes suppriment votre RESTAPI, votre fonction Lambda et les ressources associées.
Pour supprimer votre REST API
-
Dans le volet Ressources, sélectionnez APIActions, puis Supprimer API.
-
Dans la boîte API de dialogue Supprimer, entrez Confirmer, puis choisissez Supprimer.
Pour supprimer votre fonction Lambda
-
Sur la page Fonctions, sélectionnez votre fonction. Sélectionnez Actions, Supprimer.
-
Dans la boîte de dialogue Supprimer 1 fonctions, entrez
delete
, puis choisissez Supprimer.
Pour supprimer le groupe de journaux de votre fonction Lambda
-
Ouvrez la page Log groups
de la CloudWatch console Amazon. -
Sur la page Groupes de journaux, sélectionnez le groupe de journaux de votre fonction (
/aws/lambda/my-function
). Ensuite, pour Actions, choisissez Supprimer le ou les groupes de journaux. -
Dans la boîte de dialogue Supprimer le ou les groupes de journaux, choisissez Supprimer.
Pour supprimer le rôle d'exécution de votre fonction Lambda
-
Ouvrez la page Rôles
de la IAM console. -
(Facultatif) Sur la page Rôles, dans la zone de recherche, entrez
my-function
. -
Sélectionnez le rôle de votre fonction (par exemple,
my-function-
), puis choisissez Supprimer.31exxmpl
-
Dans la boîte de dialogue Supprimer
my-function-
?, entrez le nom du rôle, puis choisissez Supprimer.31exxmpl
Astuce
Vous pouvez automatiser la création et le nettoyage des AWS ressources en utilisant AWS CloudFormation or AWS Serverless Application Model (AWS SAM). Pour des exemples de AWS CloudFormation modèles, consultez les exemples de modèles pour API Gateway