README.md

Golang API Skeleton

A simple API skeleton written in Go with metrics pre-configurated

Includes

• Zap - Uber Log library
• Echo Framework
• MongoDB driver
• Go-Redis
• Prometheus
• Prometheus PushGateway
• Grafana

Dependencies

• Docker
• Docker Compose

Configuration

• Docker Compose
  • Nginx with proxy_pass preconfigured
  • API
  • MongoDB
  • Redis
  • Prometheus
  • Prometheus Push Gateway
  • Grafana

Run

make run

Usage

curl http://localhost/healthcheck

curl -i -X POST -H 'Content-Type: application/json' -d '{"name": "user name", "email": "user@email.com"}' http://localhost/user

Metrics

Access:

• http://localhost:3000 to view Grafana metrics pre-configurated
• http://localhost:9090 to view Prometheus server