Programacao

Criando um Api Gateway em Go.

Edislon Freitas
12/5/2023

                Explorando as Profundezas do API Gateway Implementado em Go: Uma Análise Detalhada.                        

       Repositório do Projeto: Api Gateway em Go no GitHub
       https://github.com/diillson/api-gateway-go

                   

       🚀 Introdução:    

                   

       Hoje, embarcaremos em uma jornada pelos meandros técnicos de um sofisticado API Gateway construído com Go. Desde a eficiência e a segurança garantidas pelo middleware até a flexibilidade e escalabilidade proporcionadas pela estrutura do código, desvendaremos cada pedaço deste engenhoso artefato de software.    

                   

       Por Que Usar um API Gateway?    

                   

       Um API Gateway age como um intermediário entre clientes e microserviços, desempenhando diversas funções críticas para otimizar e proteger a comunicação. Aqui estão algumas razões pelas quais você deveria considerar o uso de um API Gateway e os recursos que ele oferece:    

                   

       1. Roteamento e Orquestração    

                   

       O API Gateway facilita o roteamento de requisições para o serviço apropriado, possibilitando a organização e gestão eficiente de múltiplos microserviços.    

                   

       2. Segurança    

                   

       Ele atua como uma barreira de segurança, protegendo seus serviços de acessos não autorizados, ataques e vulnerabilidades, implementando autenticação, autorização e outras medidas de segurança.    

                   

       3. Taxa de Limite e Controle de Acesso    

                   

       Permite a implementação de limites de taxa para evitar o abuso da API. Você pode definir regras específicas para controlar como os usuários acessam seus serviços.    

                   

       4. Monitoramento e Análises    

                   

       Com um API Gateway, você pode monitorar facilmente suas APIs. Ele fornece insights valiosos sobre o uso, desempenho e saúde geral de seus serviços.    

                   

       5. Transformação de Dados    

                   

       Ele pode transformar requisições e respostas em tempo real. Isso é útil para garantir que a comunicação entre clientes diversos e microserviços seja eficiente e eficaz.    

                   

       6. Agregação de Requisições    

                   

       Um API Gateway pode combinar várias requisições e respostas, reduzindo o número de chamadas de API e a latência, o que resulta em uma experiência de usuário mais rápida e suave.    

                   

       7. Caching    

                   

       Para melhorar o desempenho, um API Gateway pode armazenar temporariamente dados, reduzindo o tempo de resposta e a carga nos serviços subjacentes.    

                   

       Conclusão    

                   

       Em resumo, um API Gateway é uma ferramenta essencial para gerenciar, proteger e otimizar APIs e microserviços. Ele não apenas melhora a eficiência operacional, mas também ajuda a oferecer uma experiência de usuário superior, garantindo que os serviços sejam acessíveis, seguros e responsivos.    

                   

               
‍

       🗂️ Estrutura de Pastas e Arquivos:    

                   

       A estrutura do projeto é meticulosamente organizada, garantindo uma navegação intuitiva e uma manutenção eficiente. Os principais arquivos .go, incluindo main.go, residem em diretórios adotados pela comunidade no modelo Go de organizar sem muita complexidade, apenas para podermos ter uma estrutura organizada em subpastas, onde armazenam os componentes relacionados.    

                              

        💡 Análise e Reflexões Técnicas:    

                   

       **Autenticação e Autorização:**    

                   

       A implementação do JWT é crucial, mas pode ser aprimorada incorporando protocolos padrão e listas negras de tokens para tokens que devem ser invalidados antes da expiração.    

                   

       **Limitação de Taxa:**    

                   

       Embora eficaz, uma abordagem mais sofisticada que leva em consideração o tipo de solicitação poderia oferecer limites dinâmicos para otimizar a utilização do serviço.    

                   

       **Logging:**    

                   

       O log é essencial para o diagnóstico e a análise. Enriquecê-lo com contextos adicionais potencializaria a identificação e a resolução de problemas.    

                   

       **Concorrência:**    

                   

       A gestão concorrente é realizada eficazmente, mas poderia ser aprimorada com estruturas de dados concorrentes mais eficientes.    

                   

       ⚙️ O Poder do Go:    

                   

       A escolha do Go para implementar este API Gateway não é acidental. Com sua eficiência, concorrência poderosa e facilidade de uso, Go oferece o desempenho e a flexibilidade necessários para um gateway robusto e escalável. Cada linha de código, cada função é um testemunho da eficiência que Go traz para a mesa, tornando-se uma escolha preferida para engenheiros que constroem infraestruturas críticas.    

                   

       Bibliotecas Utilizadas no API Gateway Go    

                   

       Neste projeto de API Gateway, várias bibliotecas Go poderosas e eficientes são utilizadas para garantir a funcionalidade, escalabilidade e desempenho otimizados. Aqui está um olhar mais detalhado sobre cada uma delas:    

                   

       1.Gin    

‍

  • Website: Gin Web Framework
  • Descrição: Gin é um framework web HTTP para construir APIs. Ele é conhecido por sua velocidade e baixo consumo de memória, tornando-se uma escolha popular para aplicativos que necessitam de desempenho otimizado. No API Gateway, Gin é usado para manipular solicitações HTTP, rotas e middleware.

   

       2.Gorm    

‍

  • Website: GORM
  • Descrição: GORM é um ORM (Object-Relational Mapping) para Go. Ele ajuda na manipulação de bancos de dados, oferecendo uma interface amigável para realizar operações como Create, Read, Update e Delete (CRUD). Neste projeto, GORM é utilizado para gerenciar e operar no banco de dados SQLite.

   

       3.Zap    

‍

  • Website: Zap
  • Descrição: Zap é uma biblioteca de logging para Go. É rápida e oferece uma interface flexível para registrar mensagens em vários níveis de severidade. Neste projeto, Zap é empregado para capturar, registrar e monitorar as atividades e operações do API Gateway.

   

                   

       4.JWT-Go    

‍

  • GitHub: JWT-Go
  • Descrição: JWT-Go é uma biblioteca Go para criar e validar tokens JWT (JSON Web Tokens). É eficiente e fácil de usar. No contexto deste API Gateway, JWT-Go é utilizado para implementar a autenticação baseada em tokens.

   

       5.Rate    

‍

  • Parte do pacote: x/time/rate
  • Descrição: Esta biblioteca é parte do pacote x/time do Go e é usada para implementar a limitação de taxa. No projeto, é aplicada para controlar o número de solicitações que um usuário pode fazer em um período específico, prevenindo assim abusos e garantindo a qualidade do serviço.

‍

       Considerações    

                   

       Estas bibliotecas foram escolhidas pela sua eficiência, facilidade de uso e comunidade ativa. Elas se integram perfeitamente para criar um API Gateway robusto e eficiente. O Gin oferece velocidade e eficiência, o GORM oferece uma manipulação de banco de dados simplificada, o Zap garante que todas as atividades sejam registradas e monitoradas de forma eficaz, e o JWT-Go assegura que a autenticação e a segurança estejam no seu melhor.    

                   

       Ao utilizar estas bibliotecas juntas, conseguimos criar um sistema que não só é performático e seguro, mas também fácil de manter e expandir, garantindo assim que o API Gateway possa escalar e evoluir junto com as necessidades do negócio.    

                   

       🛠️ Instalação e Configuração    

                   

       

  1. Clone o Repositório:

   

                 git clone https://github.com/diillson/api-gateway-go.git

cd api-gateway-go                    

       

  1. Instale as Dependências:

   

                 go mod tidy                    

       

  1. Inicialize o Servidor:

   

                 cd cmd
go run main.go                    

       Agora o ApiGateway estará rodando no http://localhost:8080. Você receberá um token JWT no console após iniciar o servidor. Perceba caso desejar já iniciar o servidor com apis cadastradas, basta adicionar no routes.json dentro da pasta raiz de seu projeto conforme a estrutura "./routes/routes.json"    

                   

       Build    

                   

       MacOS    

                 #amd64
GOOS=darwin GOARCH=amd64 go build -o cmd/apigateway cmd/main.go

#arm64
GOOS=darwin GOARCH=arm64 go build -o cmd/apigateway cmd/main.go
                   

       Linux    

                 # amd64
$ GOOS=linux GOARCH=amd64 go build -o cmd/apigateway cmd/main.go

# arm64
$ GOOS=linux GOARCH=arm64 go build -o cmd/apigateway cmd/main.go
                   

       Windows    

                 # amd64
$ GOOS=windows GOARCH=amd64 go build -o cmd/apigateway.exe cmd/main.go

# arm64
$ GOOS=windows GOARCH=arm64 go build -o cmd/apigateway.exe cmd/main.go
                   

       📚 Uso    

                   

       Para autenticar e acessar as rotas protegidas, você precisará usar o token JWT gerado. O Gateway oferece endpoints para listar, adicionar, atualizar e deletar rotas, bem como para visualizar métricas. passando o seguinte Headers nas request:    

                 Header: Authorization
Value: Bearer seu-token
                   

       

  • Autenticar:Use o JWT token para fazer requisições autorizadas aos endpoints protegidos.
  • Adicionar Rotas:Faça uma requisição POST para /admin/register com os detalhes da rota no corpo para adicionar novas rotas.

         

                                                           
  • Visualizar Rotas:Faça uma requisição GET para /admin/apis para ver todas as rotas registradas.

‍

                                                           
  • Atualizar Rotas:Faça uma requisição PUT para /admin/update com os novos detalhes da rota para atualizá-la.
                                                           
  • Deletar Rotas:Faça uma requisição DELETE para /admin/delete com o caminho da rota na query para deletá-la.
    ‍
                                                           
  • Visualizar Métricas:Faça uma requisição GET para /admin/metrics para visualizar métricas.

‍

                                                           
  • Acesso a uma API:Faça uma requisição GET para /path-da-sua-api para visualizar o proxy acontecendo e a requisição ser realizada para a aplicação.

 

                                                           

       🛡️ Segurança    

                   

       O projeto utiliza autenticação JWT para garantir que apenas usuários autorizados possam acessar os endpoints administrativos. Além disso, a limitação de taxa está em vigor para prevenir abusos e garantir a disponibilidade do serviço.    

                   

       👩💻 Contribuição    

                   

       Sinta-se à vontade para abrir issues ou pull requests se você deseja melhorar ou discutir algo sobre o projeto.    

                   

       📄 Licença    

                   

       Este projeto está sob a licença GPL - veja o arquivo LICENSE para detalhes.    

                   

       🌟 Agradecimentos    

                   

       Agradecemos a todos que de alguma forma poder contribuir e apoiar o desenvolvimento deste projeto. Sua ajuda é inestimável para tornar este projeto ótimo!    

                   

       Repositório do Projeto: Api Gateway em Go no GitHub
        https://github.com/diillson/api-gateway-go