Commencez avec API Gateway - APIPasserelle Amazon

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 avec API Gateway

Dans cet exercice de mise en route, vous allez créer un serveur sans serveurAPI. Le mode APIs Serverless vous permet de vous concentrer sur vos applications, au lieu de perdre du temps à provisionner et à gérer des serveurs. Cet exercice prend moins de 20 minutes et peut être réalisé avec AWS l'offre gratuite.

Vous devez d'abord créer une fonction Lambda à l'aide de la AWS Lambda console. Ensuite, vous créez un HTTP API à l'aide de la console API Gateway. Ensuite, vous invoquez votreAPI.

Note

Cet exercice utilise un HTTPAPI. APIGateway prend également en charge RESTAPIs, ce qui inclut plus de fonctionnalités. Pour un didacticiel utilisant un RESTAPI, voirCommencez à utiliser la REST API console.

Pour plus d'informations sur la différence entre HTTP APIs et RESTAPIs, voirChoisissez entre REST APIs et HTTP APIs.

Lorsque vous invoquez votre HTTPAPI, API Gateway achemine la demande vers votre fonction Lambda. Lambda exécute la fonction Lambda et renvoie une réponse à Gateway. API APIGateway vous renvoie ensuite une réponse.

Vue d'ensemble de HTTP API ce que vous créez dans ce didacticiel.

Pour effectuer cet exercice, vous avez besoin d'un AWS compte et d'un AWS Identity and Access Management utilisateur disposant d'un accès à la console. Pour de plus amples informations, veuillez consulter Configuration pour utiliser API Gateway.

É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 exemple, vous utilisez la fonction Node.js par défaut de la console Lambda.

Pour créer une fonction Lambda
  1. Connectez-vous à la console Lambda à l'adresse /lambda. https://console.aws.amazon.com

  2. Sélectionnez Create function (Créer une fonction).

  3. Sous Function name (Nom de la fonction), saisissez my-function.

  4. Pour toutes les autres options, utilisez le paramètre par défaut.

  5. Sélectionnez Create function (Créer une fonction).

L'exemple de fonction renvoie la réponse 200 aux clients, ainsi que le texte Hello from Lambda!.

Vous pouvez modifier votre fonction Lambda, à condition que la réponse de la fonction corresponde au format requis par Gateway. API

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('Hello from Lambda!'), }; return response; };

Étape 2 : Création d'un HTTP API

Ensuite, vous créez un HTTPAPI. APIGateway prend également en charge REST APIs et WebSocket APIs, mais un HTTP API est le meilleur choix pour cet exercice. RESTAPIsprennent en charge plus de fonctionnalités que HTTPAPIs, mais nous n'en avons pas besoin pour cet exercice. HTTPAPIssont conçus avec un minimum de fonctionnalités afin de pouvoir être proposés à un prix inférieur. WebSocket APIsmaintenez des connexions persistantes avec les clients pour les communications en duplex intégral, ce qui n'est pas obligatoire dans cet exemple.

HTTPAPIfournit un HTTP point de terminaison pour votre fonction Lambda. APIGateway achemine les demandes vers votre fonction Lambda, puis renvoie la réponse de la fonction aux clients.

Pour créer un HTTP API
  1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

  2. Effectuez l’une des actions suivantes :

    • Pour créer votre premierAPI, pour HTTPAPI, choisissez Build.

    • Si vous en avez déjà créé unAPI, choisissez Create API, puis Build for HTTPAPI.

  3. Sous Integrations (Intégrations), choisissez Add integration (Ajouter une intégration).

  4. Choisissez Lambda.

  5. Sous Lambda function (Fonction Lambda), saisissez my-function.

  6. Pour APIle nom, entrezmy-http-api.

  7. Choisissez Suivant.

  8. Passez en revue l'itinéraire que API Gateway crée pour vous, puis choisissez Next.

  9. Passez en revue l'étape créée par API Gateway pour vous, puis choisissez Next.

  10. Sélectionnez Create (Créer).

Vous avez maintenant créé HTTP API une intégration Lambda prête à recevoir les demandes des clients.

Étape 3 : Testez votre API

Ensuite, vous testez votre API appareil pour vous assurer qu'il fonctionne. Pour plus de simplicité, utilisez un navigateur Web pour appeler votreAPI.

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

  2. Choisissez votreAPI.

  3. Notez votre API invocationURL.

    Une fois que vous avez créé votreAPI, la console affiche votre API invocationURL.
  4. Copiez votre API invocation URL et saisissez-la dans un navigateur Web. Ajoutez le nom de votre fonction Lambda à votre appel pour URL appeler votre fonction Lambda. Par défaut, la console API Gateway crée une route portant le même nom que votre fonction Lambda,. my-function

    L'intégralité URL devrait ressembler àhttps://abcdef123.execute-api.us-east-2.amazonaws.com/my-function.

    Votre navigateur envoie une GET demande auAPI.

  5. Vérifiez votre API réponse. Vous devriez voir le texte "Hello from Lambda!" dans votre navigateur.

(Facultatif) Étape 4 : Nettoyer

Pour éviter des coûts inutiles, supprimez les ressources que vous avez créées dans le cadre de cet exercice de démarrage. Les étapes suivantes suppriment votre HTTPAPI, votre fonction Lambda et les ressources associées.

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

  2. Sur la APIspage, sélectionnez unAPI. Choisissez Actions, puis Supprimer.

  3. Sélectionnez Delete.

Pour supprimer une fonction Lambda
  1. Connectez-vous à la console Lambda à l'adresse /lambda. https://console.aws.amazon.com

  2. Sur la page Functions (Fonctions), sélectionnez une fonction. Choisissez Actions, puis Supprimer.

  3. Sélectionnez Delete.

Pour supprimer le groupe de journaux d'une fonction Lambda
  1. Dans la CloudWatch console Amazon, ouvrez la page Log groups.

  2. Sur la page Log groups (Groupes de journaux), sélectionnez le groupe de journaux de la fonction (/aws/lambda/my-function). Choisissez Actions, puis Supprimer le groupe de journaux.

  3. Sélectionnez Delete.

Pour supprimer le rôle d'exécution d'une fonction Lambda
  1. Dans la AWS Identity and Access Management console, ouvrez la page Rôles.

  2. Sélectionnez le rôle de la fonction, par exempl, my-function-31exxmpl.

  3. Choisissez Supprimer le rôle.

  4. Choisissez Oui, supprimer.

Vous pouvez automatiser la création et le nettoyage des AWS ressources en utilisant AWS CloudFormation ou AWS SAM. Pour des exemples de modèles AWS CloudFormation , veuillez consulter exemples de modèles AWS CloudFormation.

Étapes suivantes

Dans cet exemple, vous avez utilisé le AWS Management Console pour créer un fichier simple HTTPAPI. HTTPAPIInvoque une fonction Lambda et renvoie une réponse aux clients.

Voici les prochaines étapes à suivre pour continuer à travailler avec API Gateway.

Pour obtenir de l'aide de la communauté concernant Amazon API Gateway, consultez le forum de discussion sur Amazon API Gateway. Lorsque vous accédez à ce forum, vous devrez AWS peut-être vous connecter.

Pour obtenir de l'aide sur API Gateway directement auprès de Gateway AWS, consultez les options d'assistance sur la page AWS Support.

Consultez également nos questions fréquemment posées (FAQs) ou contactez-nous directement.