APICas d'utilisation de Gateway - APIPasserelle Amazon

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.

APICas d'utilisation de Gateway

La section des cas d'utilisation suivante présente un aperçu des différents types de API Gateway APIs et des différents types de développeurs qui utilisent API Gateway. Pour des informations plus détaillées sur la différence entre REST APIs et HTTPAPIs, voirChoisissez entre REST APIs et HTTP APIs.

Utiliser API Gateway pour créer REST APIs

Une API passerelle REST API est composée de ressources et de méthodes. Une ressource est une entité logique à laquelle une application peut accéder via un chemin de ressource. Une méthode correspond à une REST API demande soumise par l'utilisateur de votre choix API et à la réponse renvoyée à l'utilisateur.

Par exemple, /incomes peut-être le chemin de la ressource représentant les revenus de l'utilisateur de l'application. Une ressource peut comporter une ou plusieurs opérations définies par des HTTP verbes appropriés tels queGET,POST, PUTPATCH, etDELETE. La combinaison d'un chemin de ressource et d'une opération identifie un procédé duAPI. Par exemple, la méthode POST /incomes ajoute les revenus générés par l'appelant, et la méthode GET /expenses interroge les dépenses signalées engagées par l'appelant.

L'application n'a pas besoin de savoir où sont stockées les données demandées et à partir d'où elles sont extraites sur le back-end. Dans API Gateway RESTAPIs, le frontend est encapsulé par les demandes de méthode et les réponses de méthode. Les API interfaces avec le backend au moyen de demandes d'intégration et de réponses d'intégration.

Par exemple, avec DynamoDB comme backend, le développeur configure API la demande d'intégration pour transmettre la demande de méthode entrante au backend choisi. La configuration inclut les spécifications d'une action DynamoDB appropriée, le rôle et les politiques IAM requis, ainsi que la transformation des données d'entrée requise. Le backend renvoie le résultat à API Gateway en tant que réponse d'intégration.

Pour acheminer la réponse d'intégration vers une réponse de méthode appropriée (d'un code d'HTTPétat donné) vers le client, vous pouvez configurer la réponse d'intégration pour mapper les paramètres de réponse requis de l'intégration à la méthode. Vous pouvez ensuite appliquer le format des données de sortie du serveur principal à celui du serveur frontal, si nécessaire. APIGateway vous permet de définir un schéma ou un modèle pour la charge utile afin de faciliter la configuration du modèle de cartographie corporelle.

APIGateway fournit REST API des fonctionnalités de gestion telles que les suivantes :

  • Support pour la génération SDKs et la création de API documentation à l'aide des extensions API Gateway to Open API

  • Limitation des demandes HTTP

Utiliser API Gateway pour créer HTTP APIs

HTTPAPIsvous permettent de créer RESTful APIs avec une latence et un coût inférieurs à ceux de RESTAPIs.

Vous pouvez l'utiliser HTTP APIs pour envoyer des demandes à des AWS Lambda fonctions ou à n'importe quel point de HTTP terminaison routable publiquement.

Par exemple, vous pouvez créer un HTTP API qui s'intègre à une fonction Lambda sur le backend. Lorsqu'un client vous appelleAPI, API Gateway envoie la demande à la fonction Lambda et renvoie la réponse de la fonction au client.

HTTPAPIssupporte OpenID Connect et l'autorisation OAuth2.0. Ils sont dotés d'un support intégré pour le partage de ressources entre origines (CORS) et les déploiements automatiques.

Pour en savoir plus, veuillez consulter la section Choisissez entre REST APIs et HTTP APIs.

Utiliser API Gateway pour créer WebSocket APIs

Dans un WebSocket API, le client et le serveur peuvent s'envoyer des messages à tout moment. Les serveurs principaux peuvent facilement transférer les données aux utilisateurs et appareils connectés, ce qui évite de devoir mettre en œuvre des mécanismes d'interrogation complexes.

Par exemple, vous pouvez créer une application sans serveur à l'aide d'une API passerelle WebSocket API et AWS Lambda pour envoyer et recevoir des messages à destination et en provenance d'utilisateurs individuels ou de groupes d'utilisateurs dans un salon de discussion. Vous pouvez également invoquer des services principaux tels qu' AWS Lambda Amazon Kinesis ou HTTP un point de terminaison basé sur le contenu du message.

Vous pouvez utiliser API Gateway WebSocket APIs pour créer des applications de communication sécurisées en temps réel sans avoir à approvisionner ou à gérer des serveurs pour gérer les connexions ou les échanges de données à grande échelle. Les cas d'utilisation ciblée incluent des applications en temps réel telles que les suivantes :

  • Applications de conversation

  • Tableaux de bord en temps réel tels que symboles boursiers

  • Alertes et notifications en temps réel

APIGateway fournit WebSocket API des fonctionnalités de gestion telles que les suivantes :

  • Surveillance et limitation des connexions et des messages

  • Utilisation AWS X-Ray pour suivre les messages lorsqu'ils transitent par APIs les services principaux

  • Intégration facile avecHTTP//HTTPSendpoints

Qui utilise API Gateway ?

Deux types de développeurs utilisent API Gateway : les API développeurs et les développeurs d'applications.

Un API développeur crée et déploie un API pour activer les fonctionnalités requises dans API Gateway. Le API développeur doit être un utilisateur du AWS compte propriétaire duAPI.

Un développeur d'applications crée une application fonctionnelle pour appeler AWS des services en invoquant un WebSocket ou REST API créé par un API développeur dans API Gateway.

Le développeur de l'application est le client du API développeur. Le développeur de l'application n'a pas besoin de AWS compte, à condition qu'il ne nécessite pas d'IAMautorisations ou qu'il prenne en charge l'APIautorisation des utilisateurs par le biais de fournisseurs d'identité fédérés tiers pris en charge par la fédération d'identité des groupes d'utilisateurs Amazon Cognito. Parmi ces fournisseurs d'identité, citons Amazon, les groupes d'utilisateurs Amazon Cognito, Facebook et Google.

Création et gestion d'une API passerelle API

Un API développeur travaille avec le composant de service API Gateway pour API la gestionapigateway, nommé, pour créer, configurer et déployer unAPI.

En tant que API développeur, vous pouvez créer et gérer un en API utilisant la console API Gateway, décrite dansCommencez avec API Gateway, ou en appelant leRéférences d'API. Il existe plusieurs façons de l'appelerAPI. Ils incluent l'utilisation du AWS Command Line Interface (AWS CLI), ou l'utilisation d'un AWS SDK. En outre, vous pouvez activer API la création à l'aide de AWS CloudFormation modèles ou (dans le cas de REST APIs et HTTPAPIs)APIExtensions ouvertes pour API Gateway.

Pour obtenir la liste des régions dans lesquelles API Gateway est disponible, ainsi que les points de terminaison du service de contrôle associés, consultez Amazon API Gateway Endpoints and Quotas.

Appeler une API passerelle API

Un développeur d'applications utilise le composant de service API Gateway pour API l'exécuter, nomméexecute-api, API afin d'invoquer un composant créé ou déployé dans API Gateway. Les entités de programmation sous-jacentes sont exposées par les entités crééesAPI. Il existe plusieurs façons d'appeler un telAPI. Pour en savoir plus, consultez Invoquer des API REST dans API Gateway et Invoquer WebSocket des API.