jobsssss/golang-clean-web-api

Golang Clean architecture REST API example with a comprehensive real project. It uses docker, docker compose, redis, elasticsearch, kibana, filebeat, postgresql, prometheus, grafana. also use gin, gorm, viper, zerolog, zap, validator, dynamic search, swagger and JWT

Golang Clean Web API (Dockerize) with a full sample project (Car Sale project)

System Design Diagram

Database Design Diagram

Give a Star! ⭐

If you like this repo or found it helpful, please give it a star. Thanks!

Used Tools

1. Gin as web framework
2. JWT for authentication and authorization
3. Redis for caching
4. Elasticsearch for logging database
5. Beat for log shipping
6. Kibana as log viewer
7. Postgresql as main database engine
8. PgAdmin as database management tool
9. Prometheus for metric database
10. Grafana for metric dashboards
11. Validator for endpoint input Validation
12. Viper for configurations
13. Zap for logging
14. Zerolog for logging
15. Gorm as ORM
16. Swagger for documentation
17. Docker compose for run project with all dependencies in docker

How to run

Docker start

docker compose -f "docker/docker-compose.yml" up -d --build

Web API

Run local manually http://localhost:5005

Run in docker http://localhost:9001

Token Url: http://localhost:5005/api/v1/users/login-by-username
Username: admin
Password: 12345678

Kibana

http://localhost:5601

Username: elastic
Password: @aA123456

Grafana

http://localhost:3000

Username: admin
Password: foobar

PgAdmin

http://localhost:8090

Username: [email protected]
Password: 123456

Postgres Server info:

Host: postgres_container
Port: 5432
Username: postgres
Password: admin

Prometheus

http://localhost:9090

Docker Stop

docker compose --file 'docker/docker-compose.yml' --project-name 'docker' down

Linux

0. build Project and copy configuration

/src > go build -o ../prod/server ./cmd/main.go
/src > mkdir ../prod/config/ && cp config/config-production.yml ../prod/config/config-production.yml

1. Create systemd unit

sudo vi /lib/systemd/system/go-api.service

2. Service config

[Unit]
Description=go-api

[Service]
Type=simple
Restart=always
RestartSec=20s
ExecStart=/home/hamed/github/golang-clean-web-api/prod/server
Environment="APP_ENV=production"
WorkingDirectory=/home/hamed/github/golang-clean-web-api/prod
[Install]
WantedBy=multi-user.target

3. Start service

sudo systemctl start go-api

4. Stop service

sudo systemctl stop go-api

5. Show service logs

sudo journalctl -u go-api -e

Project preview

Swagger

Grafana

Kibana