Go REST API - Complete Demo & Documentation

📋 Project Overview

Welcome to the Go REST API - a comprehensive, enterprise-grade REST API built with Go programming language. This project demonstrates modern API development practices with authentication, database integration, caching, file uploads, and comprehensive testing.

🔐 Security First

JWT Authentication, Role-Based Access Control, Password Hashing, Rate Limiting

⚡ High Performance

Redis Caching, Optimized Queries, Concurrent Processing, Memory Efficient

🧪 Quality Assured

Unit Tests, Integration Tests, Code Coverage, Comprehensive Documentation

🐳 Production Ready

Docker Containerization, Environment Configuration, Monitoring, Scalable

📁 Project Structure

Well-organized modular architecture with clear separation of concerns:

📂 go-rest-api/

├── 📂 cmd/

│ ├── 📂 api/

│ │ └── 📄 main.go // Application entry point

│ └── 📂 seeder/

│ └── 📄 main.go // Database seeding

├── 📂 internal/

│ ├── 📂 cache/

│ │ └── 📄 cache.go // Redis caching layer

│ ├── 📂 config/

│ │ ├── 📄 config.go // Configuration management

│ │ └── 📄 config_test.go // Config tests

│ ├── 📂 database/

│ │ └── 📄 database.go // Database connection

│ ├── 📂 handlers/

│ │ ├── 📄 auth_handler.go // Authentication endpoints

│ │ ├── 📄 product_handler.go // Product CRUD operations

│ │ ├── 📄 category_handler.go // Category management

│ │ ├── 📄 upload_handler.go // File upload handling

│ │ ├── 📄 api_handler.go // General API endpoints

│ │ └── 📄 *_test.go // Unit tests

│ ├── 📂 middleware/

│ │ ├── 📄 auth_middleware.go // JWT authentication

│ │ ├── 📄 role_middleware.go // Role-based access

│ │ ├── 📄 ratelimit.go // Rate limiting

│ │ ├── 📄 cors.go // CORS handling

│ │ └── 📄 logger.go // Request logging

│ ├── 📂 models/

│ │ ├── 📄 user.go // User data model

│ │ ├── 📄 product.go // Product data model

│ │ └── 📄 category.go // Category data model

│ ├── 📂 response/

│ │ └── 📄 response.go // API response utilities

│ ├── 📂 routes/

│ │ └── 📄 routes.go // Route definitions

│ └── 📂 validation/

│ └── 📄 validation.go // Input validation

├── 📂 tests/

│ └── 📄 integration_test.go // Integration tests

├── 📂 docs/

│ └── 📄 docs.go // Swagger documentation

├── 📄 go.mod // Go module definition

├── 📄 go.sum // Dependency checksums

├── 📄 docker-compose.yml // Docker orchestration

├── 📄 Dockerfile // Container definition

├── 📄 Makefile // Build automation

├── 📄 README.md // Project documentation

├── 📄 RELEASE_NOTES.md // Release documentation

├── 📄 LICENSE // MIT License

├── 📄 .env // Environment variables

└── 📄 .gitignore // Git ignore rules

🚀 Installation & Setup Guide

1 Clone the Repository

git clone https://github.com/rskworld/go-rest-api.git

cd go-rest-api

2 Using Docker (Recommended)

# Start all services (PostgreSQL, Redis, API)

docker-compose up --build

# API will be available at: http://localhost:8080

# Swagger docs at: http://localhost:8080/swagger/index.html

3 Manual Setup (Alternative)

# Install Go dependencies

go mod download

# Configure environment

cp .env.example .env

# Edit .env with your database settings

# Run database migrations

make seed

# Start the server

make run

                💡 Prerequisites: Docker, Docker Compose, or Go 1.21+ installed on your system.
            

🔗 API Endpoints

Authentication

POST /api/v1/register

User registration with name, email, and password

POST /api/v1/login

User login with JWT token generation

GET /api/v1/profile

Get authenticated user profile (requires Bearer token)

Products Management

GET /api/v1/products

List products with search, filtering, and pagination

GET /api/v1/products/:id

Get specific product details

POST /api/v1/products

Create new product (Admin only)

PUT /api/v1/products/:id

Update product (Admin only)

DELETE /api/v1/products/:id

Delete product (Admin only)

Categories Management

GET /api/v1/categories

List all categories

GET /api/v1/categories/:id

Get category details with products

POST /api/v1/categories

Create category (Admin only)

File Management

POST /api/v1/products/:id/upload

Upload product image (Admin only)

DELETE /api/v1/products/:id/image

Delete product image (Admin only)

System

GET /api/v1/health

Health check endpoint

GET /swagger/*

API documentation (Swagger UI)

💡 Usage Examples

1. User Registration

curl -X POST http://localhost:8080/api/v1/register \

  -H "Content-Type: application/json" \

  -d '{

    "name": "John Doe",

    "email": "john@example.com",

    "password": "password123"

  }'

2. User Login

curl -X POST http://localhost:8080/api/v1/login \

  -H "Content-Type: application/json" \

  -d '{

    "email": "john@example.com",

    "password": "password123"

  }'

3. Get Products with Search

curl "http://localhost:8080/api/v1/products?search=laptop&page=1&limit=10"

4. Create Product (Admin)

curl -X POST http://localhost:8080/api/v1/products \

  -H "Authorization: Bearer YOUR_JWT_TOKEN" \

  -H "Content-Type: application/json" \

  -d '{

    "name": "Gaming Laptop",

    "description": "High-performance gaming laptop",

    "price": 1299.99,

    "stock": 50,

    "category_id": 1

  }'

5. Upload Product Image

curl -X POST http://localhost:8080/api/v1/products/1/upload \

  -H "Authorization: Bearer YOUR_JWT_TOKEN" \

  -F "image=@laptop.jpg"

🧪 Testing & Quality Assurance

Running Tests

# Run all tests

make test

# Run tests with coverage

make test-coverage

# Run integration tests

go test ./tests/...

# View coverage report

open coverage.html

Test Coverage Includes:

✅ Unit tests for all handlers
✅ Middleware testing
✅ Input validation testing
✅ Authentication testing
✅ Integration testing
✅ Error handling testing

⚙️ Configuration

Environment Variables (.env)

# Database Configuration

DB_HOST=localhost

DB_USER=postgres

DB_PASSWORD=your_password

DB_NAME=gorestapi

DB_PORT=5432

# Authentication

JWT_SECRET=your_jwt_secret_key

# Server

PORT=8080

# File Upload

UPLOAD_PATH=./uploads

# Redis Cache

REDIS_HOST=localhost

REDIS_PORT=6379

CACHE_ENABLED=true

Makefile Commands

make run          # Start the server

make build        # Build the application

make test         # Run all tests

make seed         # Run database seeder

make docker-up    # Start Docker services

make docker-down  # Stop Docker services

make clean        # Clean build artifacts

🏗️ Architecture & Features

🔐 Security

JWT Authentication
Role-Based Access Control
Password Hashing
Rate Limiting
CORS Protection

📊 Database

PostgreSQL Integration
GORM ORM
Automatic Migrations
Relationship Management
Query Optimization

⚡ Performance

Redis Caching
Efficient Pagination
Concurrent Processing
Memory Optimization
Database Indexing

🧪 Quality

Unit Testing
Integration Testing
Code Coverage
Input Validation
Error Handling

🐳 DevOps

Docker Containerization
Environment Config
Automated Testing
CI/CD Ready
Production Deployment

📚 Documentation

Swagger API Docs
Comprehensive README
Code Comments
Usage Examples
Architecture Guide

🔗 Links & Resources

📖 Documentation

Complete README
Release Notes
API Documentation

📦 Repository

GitHub Repository
Version Tags
Releases

🛠️ Technologies

Go Programming
Gin Framework
GORM ORM

📞 Support

Email Support
Website
Contact Form

🚀 Go REST API