How aleksk1ng/go-clean-architecture-rest-api works
Project type and purpose
• This is a backend‐only REST API microservice written in Go, following Uncle Bob’s Clean Architecture.
• It exposes HTTP endpoints (via Echo) for domains such as auth, news, comments, and session, persisting data in PostgreSQL and Redis, storing files in S3 (MinIO), and instrumenting with Prometheus, Grafana, and Jaeger.
File structure
• cmd/api: entrypoint (main.go) that wires together router, middleware, handlers, use cases, repositories, and config.
• config: Viper‐based configuration for local, Docker, and production.
• internal: core business logic, split by domain:
• delivery/http (handlers & routes)
• usecase (application business rules)
• repository (database/Redis/AWS implementations)
• mock (test doubles)
• internal/middleware & internal/server: HTTP middleware chain (auth, CSRF, logging, metrics, sanitizer) and server bootstrap.
• pkg: shared utilities and infrastructure helpers (DB connection, JWT, sanitization, logger, metrics, HTTP errors).
• migrations: SQL scripts to initialize and evolve the schema.
• docker & docker-compose: container images and multi‐container setups for dev, debug, monitoring.
• docs: Swagger definitions.
• ssl: certificates for local HTTPS.
README insights
• Technology stack: Echo, sqlx/pgx, go-redis, zap, validator, jwt-go, migrate, MinIO, Bluemonday, Swag, testing frameworks, Docker.
• Development workflows: make local/run, compose files, UIs for Swagger, Jaeger, Prometheus, Grafana.
Main components & their interactions
a. API Gateway & HTTP Server
• Echo HTTP server (cmd/api → internal/server)
• Global middleware chain (auth, CSRF, metrics, logging, sanitize)
b. Delivery Layer
• Domain‐specific handlers and routes (internal/*/delivery/http)
c. Application Layer (Use Cases)
• Business rules orchestrated by usecase interfaces (internal/*/usecase)
d. Infrastructure Layer (Repositories & Clients)
• PostgreSQL repositories (sqlx/pgx)
• Redis repositories (go-redis)
• AWS S3/MinIO client (minio-go)
e. Shared Services & Utilities
• Configuration loader (Viper)
• Logger (Zap)
• JWT utilities, validators, sanitizers, metrics emitters
f. External Systems
• PostgreSQL, Redis, MinIO/S3
• Prometheus (metrics), Grafana (dashboards), Jaeger (tracing)
g. Dev & CI/CD
• Dockerfiles, docker‐compose (dev/delve), GitHub Actions (test.yml)
Architectural patterns & principles
• Clean Architecture (onion or hexagonal layers) with dependency inversion:
• Outward layers implement interfaces defined inward.
• Separation of concerns: delivery → usecase → repository.
• Single responsibility per package/domain.
• Testability through dependency injection and mocks.