

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
<a name="getting-started-with-private-integration"></a>

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.\]](http://docs.aws.amazon.com/fr_fr/apigateway/latest/developerguide/images/private-integration-rest.png)


Pour suivre ce didacticiel, vous avez besoin d'un AWS compte et d'un Gestion des identités et des accès AWS utilisateur disposant d'un accès à la console. Pour de plus amples informations, veuillez consulter [Configuration d’API Gateway avant son utilisation](setting-up.md).

**Topics**
+ [Étape 1 : créer un service Amazon ECS](#rest-api-private-integration-create-ecs-service)
+ [Étape 2 : créer un lien VPC](#http-api-private-integration-vpc-link)
+ [Étape 3 : Création d'une API REST](#http-api-private-integration-create-api)
+ [Étape 4 : Testez votre API](#rest-api-private-integration-test-api)
+ [Étape 5 : déploiement de votre API](#rest-api-private-integration-deploy-api)
+ [Étape 6 : appelez votre API](#rest-api-private-integration-call)
+ [Étape 7 : nettoyer](#rest-api-private-integration-cleanup)

## Étape 1 : créer un service Amazon ECS
<a name="rest-api-private-integration-create-ecs-service"></a>

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](samples/rest-private-integration-tutorial.zip), 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.](https://console.aws.amazon.com/cloudformation/)

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

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

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

1. Choisissez **Suivant**. 

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

1. Pour **Configurer les options de pile**, choisissez **Suivant**.

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

1. Choisissez **Suivant**, puis **Soumettre**.

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

## Étape 2 : créer un lien VPC
<a name="http-api-private-integration-vpc-link"></a>

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.](https://console.aws.amazon.com/apigateway)

1. 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.

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

1. Pour **Nom**, saisissez **private-integrations-tutorial**.

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

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

1. 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`.

1. 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
<a name="http-api-private-integration-create-api"></a>

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.](https://console.aws.amazon.com/apigateway)

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

1. Pour **Nom**, saisissez **private-integration-api**.

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

1. Sélectionnez **Create API** (Créer une API).

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

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

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

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

   1. Activez **Intégration de proxy VPC**.

   1. Pour **Méthode HTTP**, sélectionnez `GET`.

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

   1. 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-**.

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

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

   1. 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
<a name="rest-api-private-integration-test-api"></a>

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.](https://console.aws.amazon.com/apigateway)

1. Choisissez votre API.

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

1. 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
<a name="rest-api-private-integration-deploy-api"></a>

Ensuite, vous déployez votre API.

**Pour déployer votre API**

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

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

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

1. (Facultatif) Sous **Description**, entrez une description.

1. Choisissez **Déployer**.

## Étape 6 : appelez votre API
<a name="rest-api-private-integration-call"></a>

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.

1. 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
<a name="rest-api-private-integration-cleanup"></a>

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.](https://console.aws.amazon.com/apigateway)

1. Sur la **APIs**page, 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.](https://console.aws.amazon.com/apigateway)

1. Choisissez **Lien VPC**.

1. 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.](https://console.aws.amazon.com/cloudformation/)

1. Sélectionnez votre CloudFormation pile.

1. Choisissez **Supprimer**, puis confirmez votre choix.