Welcome to the Management API Go project! This is a sample application that demonstrates how to integrate various modern technologies into a single project. The goal is to show how to build a robust API using Go, MySQL, Kafka, and Docker.
This application is a management API developed in Go, with data persistence in MySQL and asynchronous communication using Kafka. The project aims to illustrate how different technologies can be applied together to create a complete solution.
- Go (Golang): Main programming language of the project.
- MySQL: Relational database for data storage.
- Kafka: Distributed messaging system for asynchronous communication.
- Docker & Docker Compose: Containerization of services and simplified environment setup.
- GitHub Actions: Continuous integration for automated testing.
- Makefile: Automation of common development commands.
management-api-go/
├── .github/
│ └── workflows/
│ └── ci.yml
├── cmd/
│ └── api/
│ └── main.go
├── internal/
│ ├── domain/
│ │ ├── entities/
│ │ │ └── user.go
│ │ └── repositories/
│ │ └── user_repository.go
│ ├── infra/
│ │ ├── database/
│ │ │ └── db.go
│ │ ├── kafka/
│ │ │ └── producer.go
│ │ └── persistence/
│ │ └── user_repository_db.go
│ ├── interfaces/
│ │ ├── controllers/
│ │ │ └── user_controller.go
│ │ └── routes/
│ │ └── routes.go
│ └── usecases/
│ ├── user_usecase.go
│ └── user_usecase_test.go
├── Dockerfile
├── docker-compose.yml
├── Makefile
├── go.mod
├── go.sum
└── README.md
- Go installed (version 1.23 or higher)
- Docker e Docker Compose installed
-
Clone the repository:
git clone https://github.com/dsperax/management-api-go.git cd management-api-go -
Start the services with Docker Compose:
make setup-db
This will start MySQL and Kafka in Docker containers.
-
Run the application:
make run
The API will be running at http://localhost:8080.
-
Swagger:
http://localhost:8080/swagger/index.html -
Test the API:
Use tools like Postman or curl to interact with the API.
-
Grafana:
http://localhost:3000
- Fork the project.
- Create a branch for your feature (git checkout -b feature/new-feature).
- Commit your changes (git commit -m 'Add new feature').
- Push to the branch (git push origin feature/new-feature).
- Open a Pull Request.
- Wait for approval.
Bem-vindo ao projeto Management API Go! Este é um exemplo de aplicação que demonstra como integrar várias tecnologias modernas em um único projeto. O objetivo é mostrar como construir uma API robusta utilizando Go, MySQL, Kafka e Docker.
- Sobre o Projeto
- Tecnologias Utilizadas
- Estrutura do Projeto
- Como Executar Localmente
- Como Contribuir
- Licença
Esta aplicação é uma API de gerenciamento desenvolvida em Go, com persistência de dados em MySQL e comunicação assíncrona utilizando Kafka. O projeto visa ilustrar como diferentes tecnologias podem ser aplicadas em conjunto para criar uma solução completa.
- Go (Golang): Linguagem de programação principal do projeto.
- MySQL: Banco de dados relacional para armazenamento de dados.
- Kafka: Sistema de mensagens distribuído para comunicação assíncrona.
- Docker & Docker Compose: Containerização dos serviços e configuração facilitada do ambiente.
- GitHub Actions: Integração contínua para testes automatizados.
- Makefile: Automação de comandos comuns de desenvolvimento.
management-api-go/
├── .github/
│ └── workflows/
│ └── ci.yml
├── cmd/
│ └── api/
│ └── main.go
├── internal/
│ ├── domain/
│ │ ├── entities/
│ │ │ └── user.go
│ │ └── repositories/
│ │ └── user_repository.go
│ ├── infra/
│ │ ├── database/
│ │ │ └── db.go
│ │ ├── kafka/
│ │ │ └── producer.go
│ │ └── persistence/
│ │ └── user_repository_db.go
│ ├── interfaces/
│ │ ├── controllers/
│ │ │ └── user_controller.go
│ │ └── routes/
│ │ └── routes.go
│ └── usecases/
│ ├── user_usecase.go
│ └── user_usecase_test.go
├── Dockerfile
├── docker-compose.yml
├── Makefile
├── go.mod
├── go.sum
└── README.md
- Go instalado (versão 1.23 ou superior)
- Docker e Docker Compose instalados
-
Clone o repositório:
git clone https://github.com/dsperax/management-api-go.git cd management-api-go -
Inicie os serviços com Docker Compose:
make setup-db
Isso irá iniciar o MySQL e o Kafka em contêineres Docker.
-
Execute a aplicação:
make run
A API estará rodando em http://localhost:8080.
-
Swagger:
http://localhost:8080/swagger/index.html -
Teste a API:
Utilize ferramentas como Postman ou curl para interagir com a API.
-
Grafana:
http://localhost:3000
- Faça um fork do projeto.
- Crie uma branch para sua feature (git checkout -b feature/nova-feature).
- Commit suas alterações (git commit -m 'Adiciona nova feature').
- Faça o push para a branch (git push origin feature/nova-feature).
- Abra um Pull Request.
- Espere a aprovação.
# TODO
### Passo 1: Configurar o Grafana para Usar o Prometheus como Fonte de Dados
Após iniciar os serviços, você precisará configurar o Grafana para usar o Prometheus como fonte de dados.
1.1. Acessar o Grafana
Abra o Grafana no navegador:
arduino
Copiar código
http://localhost:3000
1.2. Login no Grafana
Usuário: admin
Senha: admin
Você será solicitado a alterar a senha após o primeiro login.
1.3. Adicionar Fonte de Dados
Clique em "Add your first data source" ou vá em Configuration (engrenagem) > Data Sources e clique em "Add data source".
Selecione Prometheus.
Configure a fonte de dados:
Name: Prometheus
URL: http://prometheus:9090
Access: Server (Default)
Clique em "Save & Test".
Você deve ver a mensagem "Data source is working".
### Passo 2: Importar um Dashboard para Visualizar as Métricas
Você pode criar seus próprios dashboards ou importar dashboards existentes.
2.1. Importar um Dashboard Existente
No Grafana, clique no ícone de "Plus" na barra lateral e selecione "Import".
Importar pelo ID do Dashboard
Você pode usar o ID de um dashboard existente da comunidade. Por exemplo, para um dashboard básico do Go, use o ID "1860".
Clique em "Load".
Selecione a fonte de dados
Em Prometheus, selecione a fonte de dados que você configurou.
Clique em "Import".
Agora você deve ver um dashboard com métricas da sua aplicação Go.
### Passo 3: Verificar se as Métricas Estão Sendo Coletadas
Certifique-se de que o Prometheus está coletando as métricas da sua aplicação.
3.1. Acessar o Prometheus
Abra o Prometheus no navegador:
arduino
Copiar código
http://localhost:9090
Você pode executar consultas para verificar as métricas disponíveis.
### Passo 8: Testar o Ambiente
Faça algumas requisições à sua aplicação Go para gerar atividade.
Verifique no Grafana se as métricas estão sendo atualizadas nos dashboards.