Desenvolver APIs REST no API Gateway

No Amazon API Gateway, você cria uma API REST como uma coleção de entidades programáveis conhecida como recursos do API Gateway. Por exemplo, você usa um recurso RestApi para representar uma API que pode conter uma coleção de entidades Recurso.

Cada entidade Resource pode ter um ou mais recursos Method. Um Method é uma solicitação recebida que foi enviada pelo cliente e é expressa nos parâmetros e no corpo da solicitação. Ele define a interface de programação de aplicações para o cliente acessar o Resource exposto. Para integrar o Method a um endpoint de back-end, também conhecido como endpoint de integração, crie um recurso Integration. Isso encaminha a solicitação recebida para um URI de endpoint de integração especificado. Se necessário, você pode transformar os parâmetros ou o corpo da solicitação para atender aos requisitos de backend.

Para as respostas, você pode criar um recurso MethodResponse para representar uma resposta de solicitação recebida pelo cliente e um recurso IntegrationResponse para representar a resposta de solicitação que é retornada pelo back-end. Você pode configurar a resposta de integração para transformar os dados de resposta de backend antes de retornar os dados para o cliente ou transmitir a resposta do backend da forma em que se encontra para o cliente.

Para ajudar seus clientes a compreender sua API, você também pode fornecer sua documentação como parte da criação da API ou depois de criá-la. Para fazer isso, adicione um recurso DocumentationPart para uma entidade de API compatível.

Para controlar como os clientes chamam uma API, use permissões do IAM, um autorizador de Lambda ou um grupo de usuários Amazon Cognito. Para medir o uso da sua API, configure planos de uso para limitar as solicitações de API. Você pode habilitá-los ao criar ou atualizar a API.

Para conferir uma introdução sobre como criar uma API, consulte Tutorial: Crie uma API REST com uma integração de proxy do Lambda. Para obter mais informações sobre os recursos do API Gateway que você pode usar ao desenvolver uma API REST, consulte os tópicos a seguir. Esses tópicos contêm informações conceituais e procedimentos que você pode executar usando o console do API Gateway, a API REST do API Gateway, a AWS CLI ou um dos AWS SDKs.