Perguntas frequentes sobre o Amazon API Gateway

O Amazon API Gateway é um serviço gerenciado que facilita para os desenvolvedores a publicação, a manutenção, o monitoramento e a proteção das APIs em qualquer escala. Com apenas alguns cliques no Console de Gerenciamento da AWS, você pode criar uma API que atua como uma "porta de entrada" para que aplicativos acessem dados, lógica de negócios ou funcionalidades por meio de serviços de back-end, como aplicativos executados no Amazon Elastic Compute Cloud (Amazon EC2), no Amazon Elastic Container Service (Amazon ECS) ou no AWS Elastic Beanstalk, código executado no AWS Lambda ou qualquer aplicativo web. O Amazon API Gateway processa todas as tarefas relacionadas à aceitação e ao processamento de até centenas de milhares de chamadas simultâneas de APIs, incluindo gerenciamento de tráfego, autorização e controle de acesso, monitoramento e gerenciamento de versões de APIs. O Amazon API Gateway não tem taxas mínimas ou custos antecipados. Para APIs HTTP e APIs REST, você paga apenas pelas chamadas de API recebidas e pela quantidade de dados transferida para fora. Para APIs do WebSocket, você paga apenas pelas mensagens enviadas e recebidas e pelo tempo que um usuário/dispositivo fica conectado à API do WebSocket.

O Amazon API Gateway oferece aos desenvolvedores um serviço simples, flexível, totalmente gerenciado e com pagamento conforme o uso que trata de todos os aspectos da criação e da operação de APIs robustas para back-ends de aplicativos. Com o API Gateway, você pode ativar novos serviços com mais rapidez e menos investimento, o que permite a você se concentrar na criação dos serviços de negócios essenciais. O API Gateway foi criado para ajudar nos diversos aspectos da criação e do gerenciamento de APIs:

1) Medição. O API Gateway ajuda você a definir planos que medem e restringem o acesso de desenvolvedores externos às suas APIs. Você pode definir um conjunto de planos, configurar controles e limites de cotas por chave de API. O API Gateway mensura o tráfego automaticamente para as suas APIs e permite que você extraia dados de utilização para cada chave de API.

2) Segurança. O API Gateway oferece diversas ferramentas para autorizar o acesso às APIs e para controlar o acesso às operações dos serviços. O Amazon API Gateway permite usar as ferramentas de administração e segurança da AWS, como o AWS Identity and Access Management (IAM) e o Amazon Cognito, para autorizar o acesso às suas APIs. O Amazon API Gateway pode verificar chamadas de APIs assinadas em seu nome usando a mesma metodologia usada pela AWS para as suas próprias APIs. Usando autorizadores autorizados escritos como funções do AWS Lambda, o API Gateway também pode ajudá-lo a verificar tokens ao portador recebidos, removendo as preocupações com autorização de seu código de back-end.

3) Resiliência. O API Gateway ajuda você a gerenciar o tráfego com controle de utilização para que as operações de back-end comportem picos de tráfego. Além disso, o API Gateway ajuda a aumentar a performance das APIs e da latência experimentada pelos usuários finais, armazenando a saída das chamadas de API em cache para evitar a interação frequente com o back-end.

4) Monitoramento de operações. Depois da publicação e do uso de uma API, o API Gateway disponibiliza um painel de métricas para o monitoramento de chamadas aos serviços. A integração do painel do API Gateway com o Amazon CloudWatch oferece métricas de performance de back-end, abrangendo chamadas de API, dados de latência e taxas de erros. Você pode ativar métricas detalhadas para cada método nas APIs, bem como receber logs de erro, de acesso ou de depuração no CloudWatch Logs.

5) Gerenciamento do ciclo de vida. Frequentemente, após a publicação de uma API, é necessário criar e testar novas versões que aprimorem ou adicionem novas funcionalidades. O API Gateway permite operar várias versões e várias etapas de cada versão de API simultaneamente, possibilitando que aplicações existentes continuem a chamar versões anteriores após a publicação de novas versões de uma API.

6) Projetado para desenvolvedores. O API Gateway oferece agilidade na criação de APIs e na atribuição de conteúdo estático a suas respostas, reduzindo o esforço de desenvolvimento entre equipes e o tempo necessário para os aplicativos entrarem no mercado. As equipes que dependem das APIs podem iniciar o desenvolvimento enquanto você cria os processos de back-end.

7) Comunicação bidirecional em tempo real. Crie aplicativos de comunicação bidirecional em tempo real, como aplicativos de bate-papo, painéis de streaming e notificações, sem precisar executar ou gerenciar nenhum servidor. O API Gateway mantém uma conexão persistente entre usuários conectados e permite a transferência de mensagens entre eles.

O Amazon API Gateway oferece duas opções para criar APIs RESTful, APIs HTTP e APIs REST, além de uma opção para criar APIs do WebSocket.

API HTTP: as APIs HTTP são otimizadas para o desenvolvimento de APIs que são proxy para funções do AWS Lambda ou backends HTTP, tornando-as ideais para workloads com tecnologia sem servidor. No momento, não oferecem funcionalidade de gerenciamento de APIs.

API REST: as APIs REST oferecem funcionalidade de proxy de API e recursos de gerenciamento de API em uma única solução. As APIs REST oferecem recursos de gerenciamento de API, como planos de uso, chaves de API e APIs de publicação e monetização.

API de WebSocket: as APIs de WebSocket mantêm uma conexão persistente entre os clientes conectados para habilitar a comunicação de mensagens em tempo real. Com as APIs do WebSocket no API Gateway, você pode definir integrações de back-end com funções do AWS Lambda, Amazon Kinesis ou qualquer endpoint de HTTP a ser chamado quando as mensagens são recebidas dos clientes conectados.

Para começar a usar as APIs HTTP, você pode usar o console do Amazon API Gateway, a AWS CLI, os AWS SDKs ou o AWS CloudFormation. Para saber mais sobre como começar a usar as APIs HTTP, visite a nossa documentação.

Para começar a usar as APIs REST, você pode usar o console do Amazon API Gateway, a AWS CLI ou os AWS SDKs. Para saber mais sobre como começar a usar as APIs REST, visite a nossa documentação.

Você pode criar APIs RESTful usando APIs HTTP e APIs REST no Amazon API Gateway.

As APIs HTTP foram otimizadas para criar APIs que fazem proxy para funções do AWS Lambda ou back-ends HTTP, tornando-as ideais para cargas de trabalho sem servidor. As APIs HTTP são uma alternativa mais barata e rápida às APIs REST, mas atualmente não oferecem suporte à funcionalidade de gerenciamento de API. As APIs REST se destinam às APIs que exigem funcionalidade de proxy de API e recursos de gerenciamento de API em uma única solução.

As APIs HTTP são ideais para:

1. Criar APIs de proxy para o AWS Lambda ou qualquer endpoint HTTP
2. Criar APIs modernas equipadas com autorização OIDC e OAuth 2 
3. Cargas de trabalho que provavelmente crescerão muito
4. APIs para cargas de trabalho sensíveis à latência

1. Clientes que desejam pagar um preço único por um conjunto abrangente de recursos necessários para criar, gerenciar e publicar suas APIs. 

As APIs HTTP são padrão com suporte a CORS, suporte a OIDC e OAuth2 para autenticação e autorização, e implantações automáticas nos estágios.

Sim, você pode importar uma definição de API usando o OpenAPI 3. Isso resultará na criação de rotas, integrações e modelos de API. Para obter mais informações sobre a importação de definições de OpenAPI, consulte nossa documentação.

Para migrar da sua API REST atual para uma API HTTP no Amazon API Gateway, faça o seguinte:

1. Verifique se todos os recursos necessários estão disponíveis em HTTP. Para ver a lista completa de recursos, visite nossa documentação. 
2. Acesse sua API REST e exporte a definição de OpenAPI de sua API REST
3. Acesse sua API HTTP e importe a definição de OpenAPI da etapa anterior
4. Teste as funções da API conforme o esperado
5. Atualize seus clientes com a nova URL

Embora sua API possa funcionar, você pode observar alguns recursos ausentes. Para identificar recursos ausentes, faça uma análise dos campos Informações, Aviso e Erro da operação de importação. Para obter mais informações sobre como migrar APIs REST para APIs HTTP, consulte nossa documentação.

Primeiro, acesse sua REST e exporte a definição de OpenAPI de sua API REST. Em seguida, acesse sua API HTTP e importe a definição de OpenAPI da etapa anterior. Embora sua API possa funcionar, você pode observar alguns recursos ausentes. Para identificar recursos ausentes, faça uma análise dos campos Informações, Aviso e Erro da operação de importação. A AWS CLI retornará informações sobre sua API nos seus campos de informações e aviso. Para saber mais, leia a nossa documentação.

Para começar, você pode criar uma API do WebSocket usando o Console de Gerenciamento da AWS, o AWS ILC ou o AWS SDKs. Em seguida, você pode definir o roteamento WebSocket para indicar os serviços de back-end, como o AWS Lambda, o Amazon Kinesis ou o endpoint de HTTP a ser chamado com base no conteúdo da mensagem. Consulte a documentação para os conceitos básicos das APIs do WebSocket no API Gateway.

Sim, todas as APIs criadas com o Amazon API Gateway expõem apenas endpoints HTTPS. O Amazon API Gateway não oferece suporte a endpoints não criptografados (HTTP). Por padrão, o Amazon API Gateway atribui um domínio interno à API, que usa automaticamente o certificado do Amazon API Gateway. Na configuração das APIs para execução em um nome de domínio personalizado, você pode fornecer o seu próprio certificado para o domínio.

As APIs criadas no Amazon API Gateway podem aceitar qualquer carga enviada por HTTPS para APIs HTTP, APIs REST e APIs do WebSocket. Os formatos de dados comuns incluem JSON, XML, parâmetros de query string e cabeçalhos de solicitação. Você pode declarar qualquer tipo de conteúdo para as respostas das APIs e usar os modelos de transformação para alterar a resposta do back-end para o formato desejado.

O Amazon API Gateway pode executar funções do AWS Lambda em sua conta, iniciar máquinas em estado de AWS Step Functions ou chamar endpoints HTTP hospedados no AWS Elastic Beanstalk, Amazon EC2 e também operações baseadas em HTTP não hospedadas na AWS acessíveis via internet pública. O API Gateway também permite que você especifique um modelo de mapeamento para gerar o conteúdo estático a ser retornado, ajudando você a simular suas APIs antes que o back-end esteja pronto. Você também pode integrar diretamente o API Gateway com outros serviços da AWS. Por exemplo, é possível expor um método de API no API Gateway que envia dados diretamente ao Amazon Kinesis.

O API Gateway gera SDKs personalizados para desenvolvimento de aplicativos móveis com Android e iOS (Swift e Objective-C), assim como para o desenvolvimento de aplicativos web com JavaScript. O API Gateway também aceita a geração de SDKs para Ruby e Java. Após definir uma API e seus modelos no API Gateway, você poderá usar o Console AWS ou as APIs do API Gateway para gerar e fazer download de um SDK cliente. Os SDKs do cliente são gerados apenas para APIs REST no Amazon API Gateway.

Para visualizar em quais locais as APIs HTTP, as APIs REST e as APIs de WebSocket estão disponíveis, consulte a tabela de regiões da AWS aqui.

Você pode usar o console do Amazon API Gateway para definir as APIs REST e seus recursos e métodos associados, gerenciar o ciclo de vida das APIs, gerar SDKs cliente e visualizar métricas das APIs. Você também pode usar o console do API Gateway para definir seus planos de uso de APIs, gerenciar chaves de API de desenvolvedores e configurar controles e limites de cotas. Todas as mesmas ações estão disponíveis por meio de APIs do API Gateway.

Um recurso é um objeto tipificado que faz parte do domínio da API. Cada recurso pode ter associado um modelo de dados, relacionamentos com outros recursos e pode responder a métodos diferentes. Também é possível definir recursos como variáveis para interceptar soluções a vários recursos dependentes.

Cada recurso em uma API REST pode oferecer suporte a um ou mais métodos HTTP padrão. Para cada recurso, você define os verbos aceitos (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS) e sua implementação. Por exemplo, um GET para o recurso carros deve devolver uma lista de carros. Para conectar todos os métodos de um recurso a um único endpoint de back-end, o API Gateway também oferece compatibilidade com o método "ANY".

Os planos de uso ajudam a declarar planos para desenvolvedores terceirizados que restringem o acesso apenas a certas APIs, definem aceleração e solicitam limites de cota e os associam a chaves API. Você também pode extrair dados de utilização por chave de API para analisar o uso de APIs e gerar documentos de faturamento. Por exemplo, você pode criar planos Basic, Professional e Enterprise. É possível configurar o plano de uso básico para permitir apenas 1.000 solicitações por dia e um máximo de 5 solicitações por segundo (RPS).

Com o Amazon API Gateway, cada API REST pode ter várias etapas. O objetivo das etapas é facilitar o ciclo de vida de desenvolvimento de uma API. Por exemplo, após criar as APIs e implantá-las em uma etapa de desenvolvimento, ou quando você estiver pronto para a produção, será possível implantá-las em uma etapa de produção.

No Amazon API Gateway, as etapas são semelhantes a tags. Elas definem o caminho pelo qual a implantação pode ser acessada. Por exemplo, você define uma etapa de desenvolvimento e implanta a API carros nessa etapa. O recurso poderá ser acessado em https://www.myapi.com/desenvolvimento/carros. Você também pode configurar nomes de domínio personalizados que apontam diretamente a uma etapa para evitar o uso do parâmetro adicional de caminho. Por exemplo, se você apontar myapi.com diretamente para a etapa desenvolvimento, poderá acessar o recurso carros em https://www.myapi.com/carros. As etapas podem ser configuradas usando variáveis que podem ser acessadas por meio dos seus modelos de configuração ou mapeamento de APIs.

As variáveis de etapa permitem que você defina pares de chave/valor de valores de configuração associados a uma etapa. Esses valores, similarmente às variáveis de ambiente, podem ser usados na sua configuração de API. Por exemplo, você pode definir o endpoint de HTTP para a integração do seu método como uma variável de etapa, e usar a variável na sua configuração de API em vez de codificar o endpoint. Isso permite que você use um endpoint diferente para cada etapa (como dev, beta, prod) com a mesma configuração de API. As variáveis de etapa também podem ser acessadas nos modelos de mapeamento e podem ser usadas para informar parâmetros de configuração para o seu backend do Lambda ou HTTP.

Uma política de recursos é um documento de políticas do JSON anexado a uma API para controlar se um principal especificado (geralmente um usuário ou uma função do IAM) pode invocar a API. Você pode usar uma política de recursos para habilitar usuários de uma conta diferente da AWS a acessar com segurança sua API ou para permitir que a API seja invocada apenas por meio de intervalos de endereços IP de origem ou blocos CIDR especificados. Políticas de recursos podem ser usadas com APIs REST no Amazon API Gateway.

O Amazon API Gateway registra o histórico das implantações. A qualquer momento, usando as APIs ou o console do Amazon API Gateway, você pode reverter uma etapa para uma implantação anterior.

Sim. Você pode usar nossa ferramenta de importador do Swagger de código aberto para importar as definições de APIs do Swagger para o Amazon API Gateway. A ferramenta de importador do Swagger permite criar e implantar novas APIs, bem como atualizar as já existentes.

Você pode ganhar dinheiro com APIs no API Gateway ao publicá-las como produtos no AWS Marketplace. Primeiro, você deverá registrar-se como vendedor no AWS Marketplace e enviar seus planos de uso no API Gateway como produtos. Leia aqui para saber mais sobre como ganhar dinheiro com APIs.

O API Gateway oferece a capacidade de criar, atualizar e excluir a documentação associada a cada porção da sua API, como métodos e recursos. É possível acessar a documentação relacionada às APIs por meio de AWS SDKs, da ILC, via chamadas RESTful ou ao editar strings de documentação diretamente no console do API Gateway. A documentação também pode ser importada como um arquivo Swagger, como parte da API ou separadamente, o que permite que você adicione ou atualize a documentação sem atrapalhar a definição da API. O API Gateway está em conformidade com a especificação Open API para a documentação importada de arquivos Swagger ou exportada para eles. A documentação é suportada para APIs REST no API Gateway.

Além de apoiar a documentação de API em conformidade com os padrões, o API Gateway também apoia a herança de documentos, o que torna simples definir uma string de documentação e usá-la em vários locais. A herança simplifica o processo de definir a documentação de API e pode ser convertida na representação padrão ao exportar a API como um arquivo Swagger.

Sim. Você pode aplicar uma política de recursos a uma API para restringir o acesso a uma Amazon VPC ou um VPC endpoint específico. Você também pode, usando uma conta diferente, conceder a uma Amazon VPC ou um VPC endpoint acesso a uma API privada usando uma política de recursos.