go-poc

Projeto de exemplo de uma API REST em Go.

Estrutura

• main.go: ponto de entrada da aplicação
• handlers/: camada de controladores HTTP
• services/: camada de regras de negócio
• models/: definição dos modelos de dados

Como rodar

go run main.go

Docker Build

No terminal, navegue até a raiz do projeto (onde está o Dockerfile):

cd go-poc

Construa a imagem Docker (substitua "go-api" pelo nome que preferir):

docker build -t go-api .

Escanear vulnerabilidades.

docker scout recommendations
#or
docker scout recommendations local://go-api:latest

Rode o container expondo a porta 8080:

docker run -p 8080:8080 go-api

Pronto! Sua API estará acessível em http://localhost:8080/user.

Publicação automática da imagem Docker via GitHub Actions

A publicação da imagem Docker no Docker Hub é feita automaticamente pela pipeline do GitHub Actions quando um Pull Request recebe uma label no formato:

docker-publish:vX.Y.Z

Exemplo: docker-publish:v1.2.3

Como funciona:

• Adicione a label ao PR com o valor desejado (versão semver, com ou sem o prefixo v).
• O workflow irá extrair a versão da label e publicar a imagem no Docker Hub com a tag correspondente.
• A imagem também será publicada com a tag latest.

Pré-requisitos:

• Os segredos DOCKERHUB_USERNAME e DOCKERHUB_TOKEN devem estar configurados no repositório (Settings > Secrets and variables > Actions > New repository secret).

Importante: Não é mais necessário adicionar steps manuais de push no workflow. Todo o processo é automatizado via label no PR.

Testes

Para rodar os testes unitários do projeto, execute o comando abaixo dentro da pasta src:

cd src
go test ./...
go test -cover ./...

Minikube deploy

Precisa de minikube instalado no ambiente de dev

Para start do minikube

minikube start

Iniciar o dashboard do minikube

minikube dashboard

Para aplicar os manifests do Kubernetes que estão na pasta k8s, utilize o comando abaixo no terminal, dentro da raiz do projeto:

kubectl apply -f k8s/

Esse comando irá criar (ou atualizar) todos os recursos definidos nos arquivos YAML dentro da pasta k8s, incluindo deployment e service.

Se quiser aplicar apenas um arquivo específico, use:

kubectl apply -f k8s/deployment.yaml
kubectl apply -f k8s/service.yaml

Após aplicar, para verificar os recursos criados:

kubectl get pods
kubectl get services

Se precisar expor o serviço no Minikube, use:

minikube service go-api-service

Assim, você acessa facilmente a API pelo navegador. Se precisar de mais algum comando ou ajuste, só avisar!

Via Ingress

Instale o Ingress Controller no Minikube:

minikube addons enable ingress

Aplique o manifest:

kubectl apply -f k8s/ingress.yaml

#minikube tunnel O comando abaixo cria um túnel de rede e expõe o Ingress Controller na porta 80 do seu host, resolvendo o problema de roteamento:

minikube tunnel

Deixe esse comando rodando em um terminal separado.

Agora é possivel testar usando:

curl -H "Host: go-api.local" http://localhost/user

No Minikube (especialmente com o driver docker no macOS), o Ingress geralmente é exposto em http://localhost, e não diretamente no IP da VM. Por isso, o comando curl com -H "Host: go-api.local" para localhost funciona.

Se quiser acessar pelo navegador, basta garantir que o /etc/hosts tenha:

127.0.0.1 go-api.local

ou

localhost go-api.local

Assim, você pode acessar http://go-api.local/user no navegador.

Requisitos

• Go 1.24+

Próximos passos

• Implementar rotas e lógica de negócio
• Adicionar testes