Skip to content

henriqueatila/golang-gin-best-practices / skills/golang-gin-api

golang-gin-api

Verified

Build REST APIs with Go Gin. Use when creating Go web servers, adding Gin routes, writing handlers, or asking about middleware, binding, error handling, or project structure.

FileKindSize
SKILL.mdskill md10.0 KB
metadata.jsonconfig482 B
references/background-jobs-goroutine-and-pool.mdmarkdown3.5 KB
references/background-jobs-queue-and-shutdown.mdmarkdown3.5 KB
references/defensive-handler-patterns.mdmarkdown3.7 KB
references/error-handling-apperror.mdmarkdown4.1 KB
references/error-handling-recovery.mdmarkdown1.8 KB
references/error-handling-validation.mdmarkdown3.0 KB
references/file-uploads-cloud.mdmarkdown2.4 KB
references/file-uploads-local.mdmarkdown4.0 KB
references/middleware-core.mdmarkdown4.2 KB
references/middleware-logging-and-recovery.mdmarkdown3.3 KB
references/middleware-timeout-and-custom.mdmarkdown3.2 KB
references/rate-limiting-algorithms.mdmarkdown3.5 KB
references/rate-limiting-fallback.mdmarkdown2.3 KB
references/rate-limiting-headers.mdmarkdown1.8 KB
references/rate-limiting-peruser.mdmarkdown2.4 KB
references/rate-limiting-redis-sliding.mdmarkdown2.2 KB
references/rate-limiting-redis.mdmarkdown2.9 KB
references/rate-limiting-sliding-window.mdmarkdown2.2 KB
references/rate-limiting-tiered.mdmarkdown3.0 KB
references/routing-groups-and-versioning.mdmarkdown3.8 KB
references/routing-params-and-wildcards.mdmarkdown3.4 KB
references/routing-validators-and-limits.mdmarkdown2.4 KB
references/safe-context-extraction.mdmarkdown4.3 KB
references/server-handlers-and-errors.mdmarkdown3.6 KB
references/server-setup-and-routes.mdmarkdown3.9 KB
references/websocket-auth-and-keepalive.mdmarkdown3.5 KB
references/websocket-chat-handler.mdmarkdown1.5 KB
references/websocket-hub-and-client.mdmarkdown3.9 KB
references/websocket-setup-and-echo.mdmarkdown3.4 KB
references/websocket-shutdown-and-messages.mdmarkdown3.8 KB
references/websocket-testing.mdmarkdown3.8 KB

references/rate-limiting-tiered.md

View on GitHub
# Rate Limiting — Tiered Limits

See also: `rate-limiting-algorithms.md`, `rate-limiting-redis.md`, `rate-limiting-peruser.md`, `rate-limiting-headers.md`, `rate-limiting-fallback.md`

## Tiered Limits

Different limits per user role or subscription plan. Load from config; avoid hardcoding.

```go
// pkg/middleware/rate_limiter_tiered.go
package middleware

import (
	"log/slog"
	"net/http"
	"strconv"
	"time"

	"github.com/gin-gonic/gin"
	"github.com/redis/go-redis/v9"
	"golang.org/x/time/rate"
)

// TierConfig holds rate limit parameters for one tier.
type TierConfig struct {
	Rate  rate.Limit
	Burst int
}

// DefaultTiers maps role names to limits. Override from env/config.
var DefaultTiers = map[string]TierConfig{
	"anonymous":     {Rate: 2, Burst: 5},
	"authenticated": {Rate: 20, Burst: 40},
	"premium":       {Rate: 100, Burst: 200},
}

// TieredRateLimiter applies per-role limits using the Redis token bucket.
// Reads "role" from the Gin context (set by AuthRequired middleware).
func TieredRateLimiter(rdb *redis.Client, tiers map[string]TierConfig, keyPrefix string) gin.HandlerFunc {
	fallback := tiers["anonymous"]

	return func(c *gin.Context) {
		ctx := c.Request.Context()

		role, _ := c.Get("role")
		roleStr, _ := role.(string)
		cfg, ok := tiers[roleStr]
		if !ok {
			cfg = fallback
		}

		sub, _ := c.Get("sub")
		subStr, _ := sub.(string)
		if subStr == "" {
			subStr = c.ClientIP()
		}
		base := keyPrefix + roleStr + ":" + subStr

		now := float64(time.Now().UnixNano()) / 1e9
		remaining, err := tokenBucketScript.Run(ctx, rdb,
			[]string{base + ":tokens", base + ":ts"},
			cfg.Burst, float64(cfg.Rate), now,
		).Int()

		if err != nil && err != redis.Nil {
			slog.ErrorContext(ctx, "tiered limiter redis error", "err", err, "role", roleStr)
			c.Next()
			return
		}

		c.Header("X-RateLimit-Limit", strconv.Itoa(cfg.Burst))

		if remaining < 0 {
			c.Header("X-RateLimit-Remaining", "0")
			retryAfter := int(1.0/float64(cfg.Rate)) + 1
			c.Header("Retry-After", strconv.Itoa(retryAfter))
			c.AbortWithStatusJSON(http.StatusTooManyRequests, gin.H{
				"error": "rate limit exceeded",
			})
			return
		}

		c.Header("X-RateLimit-Remaining", strconv.Itoa(remaining))
		c.Next()
	}
}
```

**Loading tiers from environment:**

```go
// config/rate_limits.go
package config

import (
	"os"
	"strconv"
	"strings"

	"golang.org/x/time/rate"
	"myapp/pkg/middleware"
)

func LoadTiers() map[string]middleware.TierConfig {
	tiers := make(map[string]middleware.TierConfig)
	for _, role := range []string{"anonymous", "authenticated", "premium"} {
		rateKey := "RATE_" + strings.ToUpper(role) + "_RPS"
		burstKey := "RATE_" + strings.ToUpper(role) + "_BURST"
		r, err := strconv.ParseFloat(os.Getenv(rateKey), 64)
		if err != nil {
			r = float64(middleware.DefaultTiers[role].Rate)
		}
		b, err := strconv.Atoi(os.Getenv(burstKey))
		if err != nil {
			b = middleware.DefaultTiers[role].Burst
		}
		tiers[role] = middleware.TierConfig{Rate: rate.Limit(r), Burst: b}
	}
	return tiers
}
```
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 323kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 323kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 323kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 323kUpdated Claude CodeCodexVerifiedInstall