decorators

Deco Framework 🚀

The Go Gopher decorator, crafting elegant APIs with simple annotations! ✨

A modern, annotation-driven Go web framework built on top of Gin. Write web APIs using simple @ annotations and let deco handle the heavy lifting - automatic route registration, middleware injection, validation, caching, rate limiting, security, and more!

✨ Why Deco?

• 🚀 Zero Boilerplate: Define routes and middleware with simple annotations
• 🛡️ Built-in Security: Automatic protection for internal endpoints
• 🔄 API Gateway: Service discovery, load balancing, circuit breakers
• 📊 Observability: Metrics, tracing, and monitoring out of the box
• ⚡ Production Ready: Optimized builds with validation and minification

🚀 Quick Start

# Install CLI
go install github.com/RodolfoBonis/deco/cmd/deco@latest

# Initialize project
deco init

# Create your first handler
# @Route("GET", "/health")
# func HealthCheck(c *gin.Context) {
#     c.JSON(200, gin.H{"status": "healthy"})
# }

# Generate and run
deco generate
go run main.go

🎯 Key Features

🔒 Security

// Automatic internal endpoint protection
r := deco.Default()

// Custom security configuration
securityConfig := &deco.SecurityConfig{
    AllowPrivateNetworks: true,
    AllowLocalhost: true,
}
r := deco.DefaultWithSecurity(securityConfig)

🔄 API Gateway

// @Route("GET", "/api/users/:id")
// @Proxy(service="user-service", discovery="consul")
func GetUserProxy(c *gin.Context) {
    // Automatically forwards to user-service
}

💾 Caching & Rate Limiting

// @Route("GET", "/users/:id")
// @Cache(ttl="5m")
// @RateLimit(limit=100, window="1m")
func GetUser(c *gin.Context) {
    // Response cached for 5 minutes, 100 requests per minute
}

📚 Documentation

• Installation Guide - Setup and configuration
• Usage Guide - How to use decorators and features
• API Reference - Complete API documentation
• Security Guide - Security features and best practices
• Proxy Guide - API Gateway functionality
• Examples - Code examples and tutorials
• CLI Reference - Command line interface

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📚 Documentation

• Installation Guide - Setup and configuration
• Usage Guide - How to use decorators and features
• API Reference - Complete API documentation
• Security Guide - Security features and best practices
• Proxy Guide - API Gateway functionality
• Examples - Code examples and tutorials
• CLI Reference - Command line interface

📄 License

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