Configuration d'une demande d'intégration d'API à l'aide de la console API Gateway

La configuration d'une méthode d'API définit la méthode et décrit ses comportements. Pour configurer une méthode, vous devez spécifier une ressource, y compris la racine (« / »), sur laquelle cette méthode est exposée, une méthode HTTP (GET, POST, etc.) et son mode d'intégration au backend ciblé. La demande et la réponse de méthode spécifient le contrat avec l'application appelante, en stipulant les paramètres que l'API peut recevoir et à quoi ressemble la réponse.

Les procédures suivantes décrivent comment utiliser la console API Gateway pour créer une demande d'intégration.

Configurer une intégration Lambda

Utilisez une intégration de fonction Lambda pour intégrer votre API à une fonction Lambda. Au niveau de l'API, il s'agit d'un type d'intégration AWS si vous créez une intégration sans proxy, ou d'un type d'intégration AWS_PROXY si vous créez une intégration proxy.

Pour configurer une intégration Lambda

1. Dans le volet Ressources, choisissez Créer une méthode.

2. Pour Type de méthode, sélectionnez une méthode HTTP.

3. Sous Integration type (Type d'intégration), choisissez Lambda function (Fonction Lambda).

4. Pour utiliser une intégration proxy Lambda, activez Intégration proxy Lambda. Pour en savoir plus sur les intégrations proxy Lambda, consultez Présentation de l'intégration de proxy Lambda API Gateway.

5. Pour Fonction Lambda, entrez le nom de la Fonction Lambda.

   Si vous utilisez une Fonction Lambda dans une région différente de celle de votre API, sélectionnez la région dans le menu déroulant et entrez le nom de la Fonction Lambda. Si vous utilisez une Fonction Lambda entre comptes, entrez l'ARN de la fonction.

6. Pour utiliser la valeur de délai d'expiration par défaut de 29 secondes, gardez Délai d'expiration activé. Pour définir un délai d'expiration personnalisé, choisissez Délai d'expiration et entrez une valeur de délai d'expiration comprise entre 50 et 29000 millisecondes.

7. (Facultatif) Vous pouvez configurer les paramètres de demande de méthode à l'aide des menus déroulants suivants. Choisissez les paramètres de demande de méthode et configurez votre demande de méthode. Pour plus d'informations, reportez-vous à l'étape 3 deModifier une demande de méthode API Gateway dans la console API Gateway.

   Vous pouvez également configurer les paramètres de votre demande de méthode après avoir créé votre méthode.

8. Choisissez Créer une méthode.

Configuration d'une intégration HTTP

Utilisez une intégration HTTP pour intégrer votre API à un point de terminaison HTTP. Au niveau API, il s'agit du type d'intégration HTTP.

Pour configurer une intégration HTTP

1. Dans le volet Ressources, choisissez Créer une méthode.

2. Pour Type de méthode, sélectionnez une méthode HTTP.

3. Pour Type d'intégration, choisissez HTTP.

4. Pour utiliser une intégration proxy HTTP, activez Intégration proxy HTTP. Pour en savoir plus sur les intégrations proxy HTTP, consultez Configuration des intégrations de proxy HTTP dans API Gateway.

5. Dans le champ HTTP method, sélectionnez le type de méthode HTTP qui correspond le mieux au service backend HTTP.

6. Pour URL de point de terminaison, entrez l'URL du service backend HTTP que cette méthode doit utiliser.

7. Pour Gestion du contenu, sélectionnez un comportement de gestion du contenu.

8. Pour utiliser la valeur de délai d'expiration par défaut de 29 secondes, gardez Délai d'expiration activé. Pour définir un délai d'expiration personnalisé, choisissez Délai d'expiration et entrez une valeur de délai d'expiration comprise entre 50 et 29000 millisecondes.

9. (Facultatif) Vous pouvez configurer les paramètres de demande de méthode à l'aide des menus déroulants suivants. Choisissez les paramètres de demande de méthode et configurez votre demande de méthode. Pour plus d'informations, reportez-vous à l'étape 3 deModifier une demande de méthode API Gateway dans la console API Gateway.

   Vous pouvez également configurer les paramètres de votre demande de méthode après avoir créé votre méthode.

10. Choisissez Créer une méthode.

Configuration d'une intégration AWS de services

Utilisez une intégration AWS de service pour intégrer votre API directement à un AWS service. Au niveau API, il s'agit du type d'intégration AWS.

Pour configurer une API Gateway, effectuez l'une des opérations suivantes :

• Créez une fonction Lambda.

• Définissez une autorisation de ressource sur la Fonction Lambda.

• Effectuez toute autre action de service Lambda.

Vous devez choisir Service AWS .

Pour configurer une intégration AWS de services

1. Dans le volet Ressources, choisissez Créer une méthode.

2. Pour Type de méthode, sélectionnez une méthode HTTP.

3. Dans Type d'intégration, sélectionnez AWS service.

4. Pour AWS Région, choisissez la AWS région que vous souhaitez que cette méthode utilise pour appeler l'action.

5. Pour le AWS service, choisissez le AWS service que vous souhaitez appeler par cette méthode.

6. Pour AWS sous-domaine, entrez le sous-domaine utilisé par le AWS service. En règle générale, vous laisserez ce champ vide. Certains services AWS peuvent prendre en charge les sous-domaines comme partie des hôtes. Consultez la documentation du service pour savoir si cela possible et, le cas échéant, obtenir davantage d'informations.

7. Dans le champ HTTP method, sélectionnez le type de méthode HTTP qui correspond à l'action. Pour le type de méthode HTTP, consultez la documentation de référence de l'API pour le AWS service que vous avez choisi pour le AWS service.

8. Pour Type d'action, sélectionnez Utiliser un nom d'action pour utiliser une action d'API ou Utiliser un remplacement de chemin pour utiliser un chemin de ressource personnalisé. Pour connaître les actions disponibles et les chemins de ressources personnalisés, consultez la documentation de référence de l'API pour le AWS service que vous avez choisi pour le AWS service.

9. Entrez un Nom d'action ou un Remplacement de chemin.

10. Pour Rôle d'exécution, entrez l'ARN du rôle IAM que la méthode va utiliser pour appeler l'action.

    Pour créer un rôle IAM, vous pouvez adapter les instructions dans Étape 1 : créer le rôle d'exécution du proxy de AWS service. Spécifiez une stratégie d'accès au format suivant, avec le nombre d'actions et de déclarations de ressources souhaité :

    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Effect": "Allow",
          "Action": [
            "action-statement"
          ],
          "Resource": [
            "resource-statement"
          ]
        },
        ...
      ]
    }  

    Pour connaître la syntaxe des instructions d'action et de ressource, consultez la documentation du AWS service que vous avez choisi pour le AWS service.

    Pour la relation d'approbation du rôle IAM, spécifiez la déclaration suivante qui autorise API Gateway à effectuer des actions au nom de votre compte AWS  :

    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Sid": "",
          "Effect": "Allow",
          "Principal": {
            "Service": "apigateway.amazonaws.com"
          },
          "Action": "sts:AssumeRole"
        }
      ]
    }

11. Pour utiliser la valeur de délai d'expiration par défaut de 29 secondes, gardez Délai d'expiration activé. Pour définir un délai d'expiration personnalisé, choisissez Délai d'expiration et entrez une valeur de délai d'expiration comprise entre 50 et 29000 millisecondes.

12. (Facultatif) Vous pouvez configurer les paramètres de demande de méthode à l'aide des menus déroulants suivants. Choisissez les paramètres de demande de méthode et configurez votre demande de méthode. Pour plus d'informations, reportez-vous à l'étape 3 deModifier une demande de méthode API Gateway dans la console API Gateway.

    Vous pouvez également configurer les paramètres de votre demande de méthode après avoir créé votre méthode.

13. Choisissez Créer une méthode.

Configurer une intégration fictive

Utilisez une intégration fictive si vous souhaitez qu'API Gateway fasse office de backend pour renvoyer des réponses statiques. Au niveau API, il s'agit du type d'intégration MOCK. Généralement, vous pouvez utiliser l'intégration MOCK si votre API n'est pas encore finalisée, mais que vous devez générer des réponses d'API pour débloquer les équipes dépendantes et réaliser les tests. Pour la méthode OPTION, API Gateway définit l'intégration MOCK par défaut afin de renvoyer des en-têtes CORS pour la ressource d'API appliquée.

Pour configurer une intégration fictive

1. Dans le volet Ressources, choisissez Créer une méthode.

2. Pour Type de méthode, sélectionnez une méthode HTTP.

3. Pour le type d'intégration, choisissez Mock.

4. (Facultatif) Vous pouvez configurer les paramètres de demande de méthode à l'aide des menus déroulants suivants. Choisissez les paramètres de demande de méthode et configurez votre demande de méthode. Pour plus d'informations, reportez-vous à l'étape 3 deModifier une demande de méthode API Gateway dans la console API Gateway.

   Vous pouvez également configurer les paramètres de votre demande de méthode après avoir créé votre méthode.

5. Choisissez Créer une méthode.