Projetando APIs na AWS

Desenvolvendo Aplicações na AWS

Ricardo Sueiras

Principal Technologist

API Gateway

 

 

• Amazon API Gateway: serviço gerenciado para criar APIs.
• Projete, implemente, gerencie e proteja suas APIs.

Recursos do Amazon API Gateway

 

• Implemente diferentes tipos de API.

Recursos do Amazon API Gateway

 

• Implemente diferentes tipos de API.
• Integre com serviços de backend.

Recursos do Amazon API Gateway

 

• Implemente diferentes tipos de API.
• Integre com serviços de backend.
• Proteja o acesso às APIs.

Recursos do Amazon API Gateway

 

• Implemente diferentes tipos de API.
• Integre com serviços de backend.
• Proteja o acesso às APIs.
• Controle taxa para proteger backends.

Recursos do Amazon API Gateway

 

• Implemente diferentes tipos de API.
• Integre com serviços de backend.
• Proteja o acesso às APIs.
• Controle taxa para proteger backends.
• Transforme cargas de requisição e resposta.

Recursos do Amazon API Gateway

 

• Implemente diferentes tipos de API.
• Integre com serviços de backend.
• Proteja o acesso às APIs.
• Controle taxa para proteger backends.
• Transforme cargas de requisição e resposta.
• Publique APIs para consumidores.

Recursos do Amazon API Gateway

 

• Implemente diferentes tipos de API.
• Integre com serviços de backend.
• Proteja o acesso às APIs.
• Controle taxa para proteger backends.
• Transforme cargas de requisição e resposta.
• Publique APIs para consumidores.
• Gerencie o ciclo de vida: versionamento, deploy, aliases.

Tipos de API

• O API Gateway tem três tipos de API:
  • REST APIs
  • HTTP APIs
  • WebSocket APIs

 

Endpoints do API Gateway

• Endpoints controlam como clientes acessam sua API.
• Edge-optimized: CloudFront gerenciado pela AWS para baixa latência global.
• Regional: implantado em uma Região AWS específica.
• Private: acessível apenas via AWS PrivateLink.
• Endpoints privados ficam fora da internet pública.

 

REST APIs

• Oferta do API Gateway mais completa em recursos.
• Baseada em modelo síncrono de requisição/resposta.

 

Casos de uso de REST API

 

• APIs corporativas que exigem gestão de ciclo de vida completa.
• APIs com controles avançados de segurança.
• Ecossistemas de desenvolvedores externos com chaves de API e planos de uso.
• Integrações diretas com serviços AWS sem Lambda.

Suporte do API Gateway a REST API

 

• Validação de requisições.
• Chaves de API.
• Planos de uso e controle de taxa.
• Cache de respostas com TTL configurável.
• Transformação de requisição/resposta via templates VTL.
• Autenticação IAM (Signature V4).
• Autorizadores Lambda, pools de usuários Cognito.

Suporte do API Gateway a REST API

 

 

• Três tipos de endpoint suportados:
  • Edge-optimized
  • Regional
  • Private
• Proteção contra exploits web com AWS WAF.
• Deploys canário.
• Observabilidade com AWS X-Ray e logs do CloudWatch.

Trade-offs de REST APIs

• Mais caro que HTTP APIs.
• Latência um pouco maior.

 

HTTP APIs

• Otimizado para desempenho e custo em vez de muitos recursos:
  • Desempenho
  • Custo

 

Casos de uso de HTTP API

• Cargas serverless e APIs com Lambda.
• Microsserviços e APIs proxy leves.
• Aplicações sensíveis à latência.
• APIs com autenticação OAuth 2.0 / OIDC.

 

Suporte do API Gateway a HTTP API

 

• Integrações e autorizadores Lambda proxy.
• Autorização JWT/OIDC nativa (Cognito, Auth0, Okta).
• Configuração CORS embutida no nível da API.
• Integrações privadas de VPC via VPC Link.
• Mapeamento básico de parâmetros para headers, query strings e paths.

Trade-offs de HTTP API

 

• HTTP APIs NÃO oferecem suporte a:

  • Chaves de API
  • Planos de uso
  • Validação de requisições
  • Cache de respostas
  • Tracing com AWS X-Ray

  • Transformação de payload com VTL

  • Suportam apenas:

    • Endpoints edge ou privados (somente regionais)

WebSocket APIs

 

• Comunicação bidirecional entre clientes e servidores.
• Conexão permanece aberta, diferente de REST e HTTP APIs.
• Servidores podem enviar dados para clientes conectados.

Casos de uso de WebSocket API

• Aplicativos de chat.
• Notificações em tempo real.
• Dashboards em tempo real.

 

Suporte do API Gateway a WebSocket API

• Transformações de dados do payload.
• Validação de requisições.
• Rotas especiais embutidas:
  • $connect: cliente estabelece conexão
  • $disconnect: cliente desconecta
  • $default: nenhuma rota correspondente encontrada

 

Cache de API

• Cachear respostas reduz carga no backend.
• Melhora o desempenho da API.
• Casos típicos:
  • Dados frequentemente solicitados
  • APIs com muitas leituras
  • Reduzir invocações do Lambda

 

Cache de API

 

• Respostas em cache expiram após um TTL configurável.
• Gerencie dados obsoletos:
  • Definindo expiração do cache
  • Limpando o cache

Boas práticas de design de API: nomeie recursos com clareza

 

• Paths devem representar recursos, não ações.
• Use substantivos, não verbos.
• Bom:
  • GET /orders/123
• Evite:
  • GET /getOrder/123

Boas práticas de design de API: versionamento

 

• Versione APIs para evoluí-las com segurança ao longo do tempo.
• Evite quebrar clientes existentes.
• Abordagens comuns:
  • Versão na URI: GET /v1/orders
  • Parâmetro de consulta: GET /orders?version=1
  • Header HTTP: Accept-Version: v1

Portais para desenvolvedores de API

• Publique e compartilhe REST APIs via um portal web.
• Forneça documentação aos consumidores da API.
• Principais recursos:
  • Documentação da API (arquivos Swagger)
  • Onboarding de consumidores
  • Downloads de SDK
  • Registro de chaves de API e fluxos de assinatura

 

Especificações OpenAPI

• OpenAPI (Swagger): padrão para descrever REST APIs.
• O API Gateway pode importar e exportar especificações OpenAPI.

 

Vamos praticar!

Desenvolvendo Aplicações na AWS