Didacticiel : création d’une API REST avec une intégration privée - Amazon API Gateway
Étape 1 : créer un service Amazon ECSÉtape 2 : créer un lien VPCÉtape 3 : Création d'une API RESTÉtape 4 : Testez votre APIÉtape 5 : déploiement de votre APIÉtape 6 : appelez votre APIÉtape 7 : nettoyer

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.

Didacticiel : création d’une API REST avec une intégration privée

Dans ce didacticiel, vous allez créer une API REST qui se connecte à un service Amazon ECS qui s'exécute dans un Amazon VPC. Les clients en dehors de votre VPC Amazon peuvent utiliser l’API pour accéder à votre service Amazon ECS.

Ce didacticiel vous prendra environ 1 heure. Tout d'abord, vous utilisez un CloudFormation modèle pour créer un service Amazon VPC et Amazon ECS. Vous utilisez ensuite la console API Gateway pour créer un lien VPC V2. Le lien VPC permet à API Gateway d’accéder à l’service Amazon ECS qui s’exécute dans votre VPC Amazon. Ensuite, vous créez une API REST qui utilise le lien VPC V2 pour se connecter à votre service Amazon ECS. Enfin, vous testez votre API.

Lorsque vous appelez votre API REST, API Gateway achemine la demande vers votre service Amazon ECS via votre lien VPC V2, puis renvoie la réponse du service.

Note

Ce didacticiel était auparavant pris en charge pour HTTP APIs, et il est désormais pris en charge pour REST à APIs l'aide du lien VPC V2.

Vue d’ensemble de l’API REST que vous créez dans ce didacticiel.

Pour suivre ce didacticiel, 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 d’API Gateway avant son utilisation.

Étape 1 : créer un service Amazon ECS

Amazon ECS est un service de gestion de conteneurs qui facilite l’exécution, l’arrêt et la gestion des conteneurs Docker sur un cluster. Dans ce didacticiel, vous exécuterez votre cluster sur une infrastructure sans serveur gérée par Amazon ECS.

Téléchargez et décompressez ce CloudFormation modèle, qui crée toutes les dépendances du service, y compris un Amazon VPC. Vous utilisez le modèle pour créer un service Amazon ECS qui utilise un Application Load Balancer.

Pour créer une CloudFormation pile

  1. Ouvrez la CloudFormation console à l'adresse https://console.aws.amazon.com/cloudformation.

  2. Choisissez Créer une pile, puis choisissez Avec de nouvelles ressources (standard).

  3. Dans Spécifier le modèle, choisissez Charger un modèle de fichier.

  4. Sélectionnez le modèle que vous avez téléchargé.

  5. Choisissez Suivant.

  6. Pour Nom de la pile, saisissez rest-api-private-integrations-tutorial, puis choisissez Suivant.

  7. Pour Configurer les options de pile, choisissez Suivant.

  8. Pour les fonctionnalités, reconnaissez que CloudFormation vous pouvez créer des ressources IAM dans votre compte.

  9. Choisissez Suivant, puis Soumettre.

CloudFormation fournit le service ECS, ce qui peut prendre quelques minutes. Lorsque le statut de votre CloudFormation pile est CREATE_COMPLETE, vous êtes prêt à passer à l'étape suivante.

Un lien VPC permet à API Gateway d’accéder aux ressources privées dans un VPC Amazon. Vous utilisez un lien VPC pour permettre aux clients d'accéder à votre service Amazon ECS via votre API REST.

Pour créer un lien VPC

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

  2. Dans le panneau de navigation principal, choisissez Liens VPC, puis Créer.

    Vous devrez peut-être sélectionner l’icône Menu pour ouvrir le volet de navigation principal.

  3. Pour Choisir une version de liaison VPC, sélectionnez VPC link V2.

  4. Pour Nom, saisissez private-integrations-tutorial.

  5. Pour VPC, choisissez le VPC que vous avez créé à l’étape 1. Son nom doit commencer par RestApiStack.

  6. Pour Sous-réseaux, sélectionnez les deux sous-réseaux privés de votre VPC. Leurs noms finissent par PrivateSubnet.

  7. Pour Groupes de sécurité, sélectionnez l’ID de groupe commençant par private-integrations-tutorial et contenant la description RestApiStack/RestApiTutorialService/Service/SecurityGroup.

  8. Choisissez Créer.

Une fois que vous avez créé votre lien VPC V2, API Gateway fournit des interfaces réseau élastiques pour accéder à votre VPC. Ce processus peut prendre quelques minutes. En attendant, vous pouvez créer votre API.

Étape 3 : Création d'une API REST

L'API REST fournit un point de terminaison HTTP pour votre service Amazon ECS.

Pour créer une API REST

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

  2. Choisissez Créer une API, puis pour API REST, choisissez Créer.

  3. Pour Nom, saisissez private-integration-api.

  4. Pour le type d'adresse IP, sélectionnez IPv4.

  5. Sélectionnez Create API (Créer une API).

    Après avoir créé votre API, vous créez une méthode.

  6. Choisissez Créer une méthode puis procédez comme suit :

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

    2. Pour Type d’intégration, sélectionnez Lien VPC.

    3. Activez Intégration de proxy VPC.

    4. Pour Méthode HTTP, sélectionnez GET.

    5. Pour le lien VPC, choisissez le lien VPC V2 que vous avez créé à l'étape précédente.

    6. Pour la cible d'intégration, entrez l'équilibreur de charge que vous avez créé avec le CloudFormation modèle à l'étape 1. Son nom doit commencer par rest-.

    7. Pour URL du point de terminaison, saisissez http://private-integrations-tutorial.com.

      L'URL est utilisée pour définir l'Hosten-tête de la demande d'intégration. Dans ce cas, l'en-tête de l'hôte estprivate-integrations-tutorial.

    8. Choisissez Créer une méthode.

      Grâce à l'intégration du proxy, l'API est prête à être testée.

Étape 4 : Testez votre API

Ensuite, vous testez l'appel de la méthode API.

Pour tester votre API

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

  2. Choisissez votre API.

  3. Choisissez l’onglet Test. Vous devrez peut-être choisir la flèche droite pour afficher l’onglet.

  4. Choisissez le test

    Vérifiez que la réponse de votre API est un message de bienvenue qui vous indique que votre application est en cours d’exécution sur Amazon ECS.

Étape 5 : déploiement de votre API

Ensuite, vous déployez votre API.

Pour déployer votre API

  1. Sélectionnez Deploy API (Déployer une API).

  2. Pour Étape, sélectionnez Nouvelle étape.

  3. Sous Stage name (Nom de l’étape), entrez Prod.

  4. (Facultatif) Sous Description, entrez une description.

  5. Choisissez Déployer.

Étape 6 : appelez votre API

Une fois votre API déployée, vous pouvez l'appeler.

Pour appeler votre API

  1. Entrez cette URL d’invocation dans un navigateur Web.

    L’URL complète doit ressembler à https://abcd123.execute-api.us-east-2.amazonaws.com/Prod.

    Votre navigateur envoie une requête GET à l’API.

  2. Vérifiez que la réponse de votre API est un message de bienvenue qui vous indique que votre application est en cours d’exécution sur Amazon ECS.

    Si le message de bienvenue s'affiche, vous avez créé avec succès un service Amazon ECS qui s'exécute dans un Amazon VPC, et vous avez utilisé une API REST API Gateway avec un lien VPC V2 pour accéder au service Amazon ECS.

Étape 7 : nettoyer

Pour éviter des coûts inutiles, supprimez les ressources que vous avez créées dans le cadre de ce didacticiel. Les étapes suivantes suppriment votre lien VPC V2, votre CloudFormation stack et votre API REST.

Pour supprimer une API REST

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

  2. Sur la APIspage, sélectionnez une API. Choisissez Actions, choisissez Supprimer, puis confirmez votre choix.

Pour supprimer un lien VPC

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

  2. Choisissez Lien VPC.

  3. Sélectionnez votre lien VPC, choisissez Supprimer, puis confirmez votre choix.

Pour supprimer une CloudFormation pile

  1. Ouvrez la CloudFormation console à l'adresse https://console.aws.amazon.com/cloudformation.

  2. Sélectionnez votre CloudFormation pile.

  3. Choisissez Supprimer, puis confirmez votre choix.