https://github.com/eneas-almeida/go-account-api-mongodb
Account API é um microserviço desenvolvido em GoLang, que utiliza um padrão arquitetural Clean Architecture.
https://github.com/eneas-almeida/go-account-api-mongodb
clean-architecture docker-compose fiber golang makefile mongodb
Last synced: 3 months ago
JSON representation
Account API é um microserviço desenvolvido em GoLang, que utiliza um padrão arquitetural Clean Architecture.
- Host: GitHub
- URL: https://github.com/eneas-almeida/go-account-api-mongodb
- Owner: eneas-almeida
- Created: 2023-12-20T15:41:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T03:44:28.000Z (over 2 years ago)
- Last Synced: 2025-01-18T03:27:14.024Z (over 1 year ago)
- Topics: clean-architecture, docker-compose, fiber, golang, makefile, mongodb
- Language: Go
- Homepage:
- Size: 376 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go Account API MongoDB
> **Account API** é um microserviço que utiliza um padrão arquitetural Clean Architecture.
## Stack
- Golang;
- Docker (MongoDB);
## Considerações iniciais
- Foi utilizado o Fiber;
- Foi utilizado o mongodb como persistência de dados;
`O que é o Fiber?`
O Fiber é um framework web construído em Go, inspirado no Express.js do Node.js e é projetado para criar aplicativos web rápidos e eficientes em Go.
### Middlewares nativos do Fiber utilizado no projeto
| Middlewares | |
| :---------- | :---------------------------------------------------------------------------------------------------------- |
| Cors | Fornece um conjunto de regras e cabeçalhos HTTP, para segurança da API. |
| Helmet | Fornece um conjunto de middlewares para segurança da API. |
| Logger | Registra detalhes de solicitação/resposta HTTP. |
| Recover | Recupera o evento Panic em qualquer parte da aplicação e fornece controle centralizado para o ErrorHandler. |
| Limiter | Limita em um determinado espaço de tempo, a quantidade de solicitações HTTP para a API. |
| RequestId | Gera um id aleatório para cada requisição HTTP na aplicação, útil para o registro de transações. |
## Documentações
- [Fiber](https://docs.gofiber.io/)
## Padrão arquitetural (Clean Architecture)
>
**Imagem:** Otávio Lemos
A escolha do padrão **Clean Architecture** para um projeto de software pode trazer diversos benefícios, mas é importante ressaltar que a escolha de uma arquitetura depende muito das necessidades específicas do projeto, das características da equipe de desenvolvimento e das metas a serem alcançadas.
**Principais vantagens:**
- Separação de responsabilidades;
- Independência de frameworks e bibliotecas;
- Testabilidade;
- Adaptabilidade a mudanças;
- Escalabilidade;
- Longevidade do software;
- Compreensão e colaboração.
## FAQ de comandos rápidos
```bash
# Baixa um pacote específico
go get
# Importa todos os pacotes
go mod tidy
# Verifica as variáveis de ambiente do Go
go env
# Instala um pacote executável dentro da pasta bin
go install
```
## Pacotes utilizados
- github.com/gofiber/fiber/v2
- go.mongodb.org/mongo-driver/mongo
- go get -u github.com/cosmtrek/air
- go get github.com/pilu/fresh
## Como utilizar o reload com o fresh
```bash
# Instala o executável
go install github.com/pilu/fresh
# Para verificar a pasta que foi instalado
# Fica dentro da bin
echo $GOPATH
```
### Configurações do fresh
```bash
# Cria o arquivo .fresh.conf e insere o código abaixo:
root: .
command: go run main.go
build_name: main
build_log: ./tmp/main.log
log_color: true
exclude_dirs:
- tmp
- vendor
- .git
include_files:
- .go
```
### Como executar o fresh
```bash
# Apenas execute com o comando abaixo, irá carregar o arquivo de conf
fresh
```
### Configurações para o debug
```bash
# Cria o arquivo .vscode/launch.json
{
"configurations": [
{
"name": "Launch",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "${workspaceFolder}",
"env": {},
"args": []
}
]
}
```
