Tutoriel : Création d'une API REST avec l'intégration privée API Gateway

Vous pouvez créer une API API Gateway avec intégration privée pour permettre à vos clients d'accéder aux ressources HTTP/HTTPS dans votre Amazon Virtual Private Cloud (Amazon VPC). Ces ressources VPC sont des points de terminaison HTTP/HTTPS sur une instance EC2 derrière un Network Load Balancer dans le VPC. Le Network Load Balancer encapsule la ressource VPC et achemine les demandes entrantes vers la ressource ciblée.

Lorsqu'un client appelle l'API, API Gateway se connecte au Network Load Balancer par le biais du lien VPC préconfiguré. Un lien VPC est encapsulé par une ressource API Gateway de VpcLink. Il est responsable de la transmission des demandes de méthode d'API aux ressources VPC et renvoie les réponses du backend à l'appelant. Pour un développeur d'API, un VpcLink est une fonctionnalité équivalente à un point de terminaison d'intégration.

Pour créer une API avec intégration privée, vous devez créer ou choisir un VpcLink existant connecté à un Network Load Balancer qui cible les ressources VPC souhaitées. Vous devez avoir les autorisations appropriées pour créer et gérer un VpcLink. Ensuite, vous configurez une méthode d'API et vous l'intégrez au VpcLink en définissant HTTP ou HTTP_PROXY comme type d'intégration, en définissant VPC_LINK comme type de connexion d'intégration, et en définissant l'identifiant VpcLink sur l'élément connectionId de l'intégration.

Note

L'équilibreur de charge réseau et l'API doivent appartenir au même compte AWS.

Pour commencer rapidement à créer une API pour accéder aux ressources VPC, nous allons passer en revue les étapes essentielles de création d'une API avec intégration privée, à l'aide de la console API Gateway. Avant de créer l'API, procédez comme suit :

1. Créez une ressource VPC, créez ou choisissez un Network Load Balancer sous votre compte dans la même région, et ajoutez l'instance EC2 hébergeant la ressource en tant que cible du Network Load Balancer. Pour de plus amples informations, veuillez consulter Configuration d'un équilibreur Network Load Balancer pour les intégrations privées API Gateway.

2. Accordez des autorisations pour créer les liens VPC pour les intégrations privées. Pour de plus amples informations, veuillez consulter Octroi d'autorisations pour créer un lien VPC.

Après avoir créé votre ressource VPC et votre Network Load Balancer avec votre ressource VPC configurée dans ses groupes cibles, suivez les instructions ci-dessous pour créer une API et l'intégrer à la ressource VPC via un VpcLink dans une intégration privée.

Pour créer une API avec une intégration privée

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

2. Si vous utilisez API Gateway pour la première fois, vous voyez une page qui vous présente les fonctions du service. Sous REST API (API REST), choisissez Build (Création). Lorsque la fenêtre contextuelle Create Example API (Créer API exemple) s'affiche, cliquez sur OK.

   Si ce n'est pas la première fois que vous utilisez API Gateway, choisissez Create API (Créer une API). Sous REST API (API REST), choisissez Build (Création).

3. Créez une API REST régionale ou optimisée pour la périphérie.

4. Sélectionnez votre API.

5. 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 Lien VPC, sélectionnez [Utilisation de variables d’étape] et saisissez ${stageVariables.vpcLinkId} dans la zone de texte ci-dessous.

      Vous pouvez définir la variable d’étape vpcLinkId après le déploiement de l’API à une étape et définir sa valeur sur l’ID du VpcLink.

   6. Pour URL de point de terminaison, entrez une URL, par exemple http://myApi.example.com.

      Ici, le nom d'hôte (par exemple, myApi.example.com) est utilisé pour définir l'en-tête Host de la demande d'intégration.

   7. Choisissez Créer une méthode.

      Avec l'intégration de proxy, l'API est prête pour le déploiement. Sinon, vous devez continuer à configurer les réponses de méthode et les réponses d'intégration appropriées.

6. Choisissez Déployer une API, puis procédez comme suit :

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

   2. Pour Nom de l'étape, entrez un nom d'étape.

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

   4. Choisissez Deploy (Déployer).

7. Dans la section Détails de l’étape, notez l’URL d’invocation qui en résulte. Vous en aurez besoin pour appeler l'API. Avant cela, vous devez configurer la variable d'étape vpcLinkId.

8. Dans le volet Étapes, choisissez l’onglet Variables d’étape, puis procédez comme suit :

   1. Choisissez Gérer les variables, puis choisissez Ajouter une variable d’étape.

   2. Pour Name (Nom), saisissez vpcLinkId.

   3. Pour Valeur, entrez l’ID de VPC_LINK, par exemple, gix6s7.

   4. Choisissez Save (Enregistrer).

      À l'aide de la variable d'étape, vous pouvez facilement passer à différents liens VPC pour l'API en modifiant la valeur de la variable d'étape.