Backend & APIs Nathan Geeksman

API Gateway patterns: quando usar BFF, agregação e roteamento

API Gateway patterns: quando usar BFF, agregação e roteamento

API Gateway patterns: quando usar BFF, agregação e roteamento

Introdução

A utilização de API Gateway tornou-se uma prática comum no desenvolvimento de software, especialmente em sistemas distribuídos e escaláveis. No entanto, a escolha correta do padrão a ser adotado é frequentemente um desafio.

Esse artigo visa fornecer informações claras sobre os padrões BFF (Backend For Frontend), agregação e roteamento na implementação de API Gateway. Esses conceitos são fundamentais para garantir uma melhor organização, escalabilidade e manutenção dos sistemas desenvolvidos.

Neste artigo você aprenderá sobre as características e vantagens de cada um desses padrões, bem como os cenários em que é recomendável utilizar um em detrimento do outro. Além disso, será abordada a escolha correta do padrão com base nas necessidades específicas da aplicação desenvolvida.

O que é e por que importa

A API Gateway é um serviço de entrada para uma aplicação, geralmente composto por várias microservices. Ela serve como intermediário entre os clientes (front-end) e as APIs internas das microsserviços, oferecendo uma camada de abstração e encapsulamento da complexidade subjacente.

O padrão BFF (Backend For Frontend) consiste em criar uma API adicional para cada tipo de cliente (por exemplo, web, mobile, desktop), que atua como um gateway para os microservices. Cada API BFF é projetada para atender às necessidades específicas do seu respectivo cliente, permitindo que eles sejam desenvolvidos e atualizados independentemente.

A agregação, por outro lado, combina múltiplas APIs em uma única interface de API Gateway. Isso permite que os clientes acessem todas as funcionalidades da aplicação através de uma única ponte.

O roteamento é um dos principais motivos para implementar uma API Gateway. Ele permite a separação das responsabilidades e a delegação entre diferentes serviços, tornando mais fácil a gestão, manutenção e escalabilidade do sistema como um todo.

Esses padrões são fundamentais para garantir que as APIs sejam eficientes, escaláveis e fáceis de usar. Eles permitem que os clientes acessem as funcionalidades da aplicação de maneira segura e transparente, sem precisar lidar com as complexidades das microsserviços subjacentes.

Ao implementar esses padrões corretamente, é possível otimizar o desempenho do sistema, reduzir a sobrecarga na API Gateway e melhorar a experiência do usuário.

Como funciona na prática

A implementação de padrões BFF, agregação e roteamento pode ser complexa, mas podemos desagregar em etapas para entender melhor como elas funcionam.

Padrão BFF:

  • Desenvolvimento de API BFF: Desenvolvemos uma API separada para cada tipo de cliente (web, mobile, desktop), que se comunica com as APIs dos microsserviços.
  • Comunicação entre API BFF e microsserviços: A API BFF chama as APIs dos microsserviços necessárias para cumprir a requisição do cliente.
  • Encapsulamento de complexidade: A API BFF oculta a complexidade das APIs dos microsserviços, fornecendo uma interface simplificada e mais fácil de usar.

Agregação:

  • Combinar múltiplas APIs: Combina as funcionalidades de várias APIs em uma única interface.
  • API Gateway centralizada: A API Gateway agrega as funcionalidades das diferentes APIs, tornando-a uma ponte única para os clientes acessarem todas as funcionalidades da aplicação.

Roteamento:

  • Definição de rotas: Definimos rotas específicas para cada tipo de requisição, direcionando o tráfego para a API certa.
  • Seleção do serviço adequado: A API Gateway seleciona automaticamente o microsserviço mais adequado para atender à requisição, com base nas regras de roteamento definidas.

Esses padrões permitem uma melhor organização e gerenciamento da infraestrutura de APIs, tornando-a mais escalável e eficiente.

Exemplo real

Vamos considerar um exemplo de uma loja online que oferece produtos de diferentes categorias, como eletrônicos, roupas e calçados. A loja deseja implementar os padrões BFF, agregação e roteamento para melhorar a experiência do usuário.

// Exemplo de configuração de rotas em uma API Gateway utilizando o Spring Cloud Gateway
routes:
  - id: eletronicos-route
    uri: http://eletronicos-service:8080
    predicates:
      - Path=/produtos/eletronicos/**
    filters:
      - AddResponseHeader=Content-Type, application/json

  - id: roupas-route
    uri: http://roupas-service:8081
    predicates:
      - Path=/produtos/roupas/**
    filters:
      - AddResponseHeader=Content-Type, application/json

  - id: agregacao-route
    uri: http://agregacao-service:8082
    predicates:
      - Path=/produtos/**
    filters:
      - AddResponseHeader=Content-Type, application/json

Nesse exemplo, a API Gateway define rotas específicas para cada tipo de produto (eletrônicos, roupas e calçados). A rota agregacao-route combina as funcionalidades das outras duas rotas, tornando-se uma ponte única para os clientes acessarem todos os produtos da aplicação.

Boas práticas

  • Defina regras de roteamento claras: Antes de implementar os padrões BFF, agregação e roteamento, é fundamental definir as regras de roteamento claras para evitar ambiguidade e garantir que a API Gateway seja capaz de selecionar o microsserviço correto para atender à requisição.
  • Use políticas de cache eficientes: É recomendável usar políticas de cache nas APIs para reduzir a carga em servidores externos e melhorar a resposta geral. Por exemplo, você pode configurar a API Gateway para armazenar respostas de microsserviços em cache por um período determinado.
  • Monitorize as rotas regularmente: Para garantir que as APIs estejam funcionando corretamente, é importante monitorizar regularmente as rotas e ajustá-las conforme necessário. Isso pode incluir coletar dados sobre o desempenho das rotas, identificar padrões de uso e ajustar a configuração para otimizar o desempenho.

Armadilhas comuns

  • Over-engineering: Uma das armadilhas mais comuns ao implementar os padrões BFF, agregação e roteamento é engenharia excessiva. Isso pode ocorrer quando você tenta resolver todos os problemas de uma vez, adicionando funcionalidades desnecessárias ou complexas que podem aumentar o custo de manutenção.
  • Desbalanceamento do carregamento: Outra armadilha comum é desbalanceamento do carregamento. Se não estiver cuidadosamente configurado, os padrões BFF e agregação podem causar um desequilíbrio no carregamento entre os microsserviços, o que pode levar a problemas de desempenho ou escalabilidade.
  • Falta de integração entre os padrões: Por fim, é comum encontrar sistemas onde os padrões BFF e agregação não estão bem integrados. Isso pode causar problemas ao tentar usar esses padrões juntos, pois podem haver conflitos ou incompatibilidades que precisam ser resolvidos.

Conclusão

Ao implementar os padrões BFF, agregação e roteamento, é importante manter a simplicidade e evitar sobre-engenharia. Isso pode ser alcançado monitorizando regularmente as rotas, garantindo a integração entre os padrões e evitando desbalanceamento do carregamento.

Para continuar melhorando suas implementações de API Gateway, considere:

  • Aprofundar na análise dos dados de desempenho e ajuste da configuração para otimizar o desempenho.
  • Avaliar a possibilidade de implementação de políticas de cache mais robustas ou avançadas, como a utilização de tecnologias de caching em memória.
  • Estudar casos de uso de API Gateway em produção e considerar melhorias baseadas nas práticas comprovadas dos demais usuários.

Essas etapas podem ajudar a garantir que suas implementações de API Gateway sejam eficientes, escaláveis e fáceis de manter.

Referências

  • Fowler, M. API Gateway Patterns. Disponível em: https://martinfowler.com/articles/api-gateway.html. Acesso: 2024.
  • Thoughtworks. BFF Pattern. Disponível em: https://www.thoughtworks.com/insights/blog/bff-pattern-behavioral-factories-front-ends. Acesso: 2024.
  • Amazon Web Services. API Gateway Documentation. Disponível em: https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html. Acesso: 2024.
  • OWASP. API Security Top 10. Disponível em: https://owasp.org/www-project-api-security/. Acesso: 2024.
  • Netflix. Microservices Architecture on AWS. Disponível em: https://aws.amazon.com/blogs/opensource/microservices-on-aws/. Acesso: 2024.