How gelerum/artpaper works
Project type and purpose
• Artpaper is a backend service: a Go (Gin)-based REST API for managing articles, users, and authentication, backed by PostgreSQL and Redis, packaged with Docker.
File structure
• cmd/api/main.go: application entry point; boots the Gin server.
• pkg/server: server initialization and router setup.
• pkg/handler: HTTP handlers (article/user/auth endpoints) + middleware.
• pkg/service: business-logic layer (articles, users, auth, cache, token storage).
• pkg/repository: persistence layer for Postgres (articles, users) + tests.
• pkg/storage: generic abstraction for storage backends.
• docs: Swagger/OpenAPI definitions for autogenerated API docs.
• docker-related: Dockerfiles (api.Dockerfile, db.Dockerfile), docker-compose.yml, .env, init.sql.
Out main components
a. API Container
• Gin HTTP Server (cmd/api + pkg/server)
• Handler Layer (pkg/handler)
• Service Layer (pkg/service)
• Repository & Storage Interfaces (pkg/repository, pkg/storage)
• Swagger Docs Endpoint
b. Database Container
• PostgreSQL (initialized via init.sql)
c. Cache & Token Storage Containers
• Redis for general cache (CACHE_*)
• Redis (TOKEN_STORAGE_*) for JWT blacklisting or session tokens
d. External Clients
• Web/mobile UI or other API consumers
Relationships and data flows
1) Client → HTTP request → API Container (Gin router)
2) Router → Middleware (auth, logging) → Handler (e.g., ArticleHandler)
3) Handler → Service: apply business rules (e.g., validate JWT, enforce permissions)
4a) Service → Cache Storage (Redis) for read/write of cached data
4b) Service → Token Storage (Redis) for blacklisted or active tokens
4c) Service → Repository → Database (PostgreSQL) for CRUD
5) Repository → Database Container → returns rows → Service → Handler → HTTP response
Architectural patterns
• Layered/Clean architecture: separation of concerns between HTTP handlers, business logic, persistence, storage.
• Dependency Injection: handlers and services depend on interfaces (repository.Storage) for testability.
• Containerized microservice style: one container per component, networked via docker-compose.
• Documentation via Swagger (OpenAPI spec in docs/swagger.yaml → served by API).