go-hsr

README

Go-HSR Template

Go HSR API Forge is a high-performance CLI tool designed to scaffold production-ready REST APIs in Go. It enforces a strict Clean Architecture pattern using the HSR (Handler, Service, Repository) methodology, enabling developers to build scalable microservices and APIs with zero boilerplate overhead.

🚀 Why choose HSR?

• Instant Scaffolding - Generate a complete, industry-standard project structure in one command.
• Clean Architecture (HSR) - Logic is decoupled across layers (HTTP, Business, Data Access) for maximum testability.
• Developer First - Includes Docker support, standardized error handling, and robust middleware out of the box.
• Zero Configuration - Get a database-ready API with GORM and SQLite configured in seconds.

📦 Getting Started

Prerequisites

• Go version: Go 1.22 or above.

Quick Start

Generate a new project directly from the terminal without cloning the repository:

1. Create a standard project:

go run [github.com/AP71/go-hsr@latest](https://github.com/AP71/go-hsr@latest) new ./my-new-api

2. Create a project with SQLite database support:

go run [github.com/AP71/go-hsr@latest](https://github.com/AP71/go-hsr@latest) new ./my-secured-api --auth

Next Steps

After generating your project:

cd my-new-api
go mod tidy
go run main.go

🏗️ Project Structure

my-new-api/
├── config/             # Database and backup configurations
├── docs/               # Swagger/OpenAPI documentation
├── internal/
│   ├── dto/            # Data Transfer Objects
│   ├── handler/        # HTTP controllers
│   ├── middleware/     # Auth and security layers
│   ├── model/          # GORM domain entities
│   ├── repository/     # Data access layer
│   ├── router/         # Gin router initialization
│   └── service/        # Business logic
├── pkg/apperror/       # Standardized error mapping
├── utils/              # JWT, Hashing, and helper functions
├── docker-compose.yml  # Container orchestration
└── Dockerfile          # Multi-stage production build

📖 Documentation

Swagger API Reference

This project integrates swaggo/swag for automated API documentation.

1. Install Swag CLI:

go install [github.com/swaggo/swag/cmd/swag@latest](https://github.com/swaggo/swag/cmd/swag@latest)

1. Generate Swagger Docs:

swag init

1. View API Docs: Run the application and navigate to http://localhost:8080/swagger/index.html to view the interactive API documentation.

🤝 Contributing

We welcome contributions! Please feel free to open issues or submit pull requests.

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.