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.
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 avec le 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.
Rubriques
Configuration d’une intégration Lambda
Utilisez une intégration de fonction Lambda pour intégrer votre API avec 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 autre que de proxy, ou d’un type d’intégration AWS_PROXY si vous créez une intégration proxy.
Pour configurer une intégration Lambda
-
Dans le volet Ressources, choisissez Créer une méthode.
Pour Type de méthode, sélectionnez une méthode HTTP.
Sous Integration type (Type d’intégration), choisissez Lambda function (Fonction Lambda).
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.
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.
-
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
50et29000millisecondes. -
(Facultatif) Vous pouvez configurer les paramètres de requête de méthode à l’aide des menus déroulants suivants. Choisissez Paramètres de requête de méthode et configurez votre demande de méthode. Pour plus d’informations, consultez l’étape 3 de la page Modification d’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.
Choisissez Créer une méthode.
Configuration d’une intégration HTTP
Utilisez une intégration HTTP pour intégrer votre API avec un point de terminaison HTTP. Au niveau de l’API, il s’agit du type d’intégration HTTP.
Pour configurer une intégration HTTP
-
Dans le volet Ressources, choisissez Créer une méthode.
Pour Type de méthode, sélectionnez une méthode HTTP.
Pour Type d’intégration, choisissez HTTP.
-
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.
-
Dans le champ HTTP method, sélectionnez le type de méthode HTTP qui correspond le mieux au service backend HTTP.
-
Pour URL de point de terminaison, entrez l’URL du service backend HTTP que cette méthode doit utiliser.
-
Pour Gestion du contenu, sélectionnez un comportement de gestion du contenu.
-
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
50et29000millisecondes. -
(Facultatif) Vous pouvez configurer les paramètres de requête de méthode à l’aide des menus déroulants suivants. Choisissez Paramètres de requête de méthode et configurez votre demande de méthode. Pour plus d’informations, consultez l’étape 3 de la page Modification d’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.
-
Choisissez Créer une méthode.
Configuration d’une intégration de service AWS
Utilisez une intégration de service AWS pour intégrer votre API directement avec un service AWS. Au niveau de l’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 de service AWS
-
Dans le volet Ressources, choisissez Créer une méthode.
Pour Type de méthode, sélectionnez une méthode HTTP.
Pour Type d’intégration, choisissez Service AWS.
-
Pour Région AWS, choisissez la région AWS que cette méthode doit utiliser pour appeler l’action.
-
Pour Service AWS, choisissez le service AWS que cette méthode doit appeler.
-
Pour Sous-domaine AWS, entrez le sous-domaine utilisé par le service AWS. 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.
-
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 d’API pour le service AWS que vous avez choisi pour Service AWS.
-
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 les actions disponibles et pour les chemins de ressource personnalisé, consultez la documentation de référence d’API du service AWS que vous avez choisi pour Service AWS.
-
Entrez un Nom d’action ou un Remplacement de chemin.
-
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 la syntaxe des déclarations d’actions et de ressources, consultez la documentation du service AWS que vous avez choisi pour Service AWS.
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" } ] } -
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
50et29000millisecondes. -
(Facultatif) Vous pouvez configurer les paramètres de requête de méthode à l’aide des menus déroulants suivants. Choisissez Paramètres de requête de méthode et configurez votre demande de méthode. Pour plus d’informations, consultez l’étape 3 de la page Modification d’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.
-
Choisissez Créer une méthode.
Configuration d’une intégration simulée
Utilisez une configuration simulée si vous souhaitez qu’API Gateway agisse en tant que backend pour renvoyer des réponses statiques. Au niveau de l’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 simulée
-
Dans le volet Ressources, choisissez Créer une méthode.
Pour Type de méthode, sélectionnez une méthode HTTP.
Pour Type d’intégration, sélectionnez Mock.
-
(Facultatif) Vous pouvez configurer les paramètres de requête de méthode à l’aide des menus déroulants suivants. Choisissez Paramètres de requête de méthode et configurez votre demande de méthode. Pour plus d’informations, consultez l’étape 3 de la page Modification d’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.
-
Choisissez Créer une méthode.
