Création d'une API REST dans Amazon API Gateway - Amazon API Gateway

Création d'une API REST dans Amazon API Gateway

Dans Amazon API Gateway, vous créez une API REST sous la forme d'un ensemble d'entités programmable, appelées ressources API Gateway. Par exemple, vous utilisez une ressource RestApi pour représenter une API qui peut contenir un ensemble d'entités Resource. Chaque entité Resource peut à son tour disposer d'une ou de plusieurs ressources Method. Exprimé dans les paramètres le corps de la demande, une Method définit l'interface de programmation d'applications afin que le client puisse accéder à la Resource exposée et représente une demande entrante envoyée par le client. Vous pouvez ensuite créer une ressource Integration pour intégrer la Method à un point de terminaison de serveur principal, aussi appelé point de terminaison d'intégration, en transmettant la demande entrante à une URI de point de terminaison d'intégration spécifiée. Si nécessaire, vous devez transformer les paramètres ou le corps de la demande pour répondre aux exigences du serveur principal. Pour les réponses, vous pouvez créer une ressource MethodResponse afin de représenter une réponse à la demande reçue par le client et créer une ressource IntegrationResponse pour représenter la réponse à la demande renvoyée par le serveur principal. Vous pouvez configurer la réponse d'intégration pour transformer les données de la réponse du serveur principal avant de les renvoyer au client ou pour transmettre la réponse du serveur principal telle quelle au client.

Pour aider vos clients à comprendre votre API, vous pouvez également fournir une documentation sur l'API, dans le cadre de la création de l'API ou une fois l'API créée. Pour ce faire, ajoutez une ressource DocumentationPart pour une entité d'API prise en charge.

Pour contrôler la manière dont les clients appellent une API, utilisez les autorisations IAM, un mécanisme d'autorisation Lambda ou un groupe d'utilisateurs Amazon Cognito. Pour mesurer l'utilisation de votre API, configurez plans d'utilisation pour limiter les demandes d'API. Vous pouvez activer ceux-ci lors de la création ou de la mise à jour de l'API.

Vous pouvez effectuer ces tâches (ou d'autres tâches) à l'aide de la console API Gateway, de l'API REST API Gateway, de l'AWS CLI ou de l'un des kits SDK AWS. Nous expliquerons comment effectuer ces tâches plus loin.