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-fallback.md

View on GitHub
# Rate Limiting — Graceful Degradation (Redis Fallback)

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

## Graceful Degradation

When Redis is unavailable, fall back to an in-memory limiter instead of blocking all requests or panicking.

```go
// pkg/middleware/rate_limiter_fallback.go
package middleware

import (
	"context"
	"log/slog"
	"sync"
	"time"

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

// FallbackRateLimiter tries Redis first; on error falls back to in-memory.
// Ensures availability over strict accuracy when Redis is down.
func FallbackRateLimiter(redisCfg RedisTokenBucketConfig, memCfg MemoryRateLimiterConfig, done <-chan struct{}) gin.HandlerFunc {
	redisLimiter := RedisTokenBucketLimiter(redisCfg)
	memLimiter := MemoryRateLimiter(memCfg, done)

	var (
		mu           sync.RWMutex
		redisHealthy = true
		lastCheck    time.Time
		checkEvery   = 10 * time.Second
	)

	checkRedis := func(ctx context.Context) bool {
		mu.RLock()
		healthy := redisHealthy
		since := time.Since(lastCheck)
		mu.RUnlock()

		if since < checkEvery {
			return healthy
		}

		mu.Lock()
		defer mu.Unlock()
		err := redisCfg.Client.Ping(ctx).Err()
		redisHealthy = err == nil
		lastCheck = time.Now()
		if err != nil {
			slog.Warn("redis unhealthy, using in-memory rate limiter", "err", err)
		} else if !healthy {
			slog.Info("redis recovered, resuming redis rate limiter")
		}
		return redisHealthy
	}

	return func(c *gin.Context) {
		if checkRedis(c.Request.Context()) {
			redisLimiter(c)
		} else {
			memLimiter(c)
		}
	}
}
```

**Why fail open (allow) on Redis errors:** Blocking all traffic because a cache is down is worse than briefly allowing excess traffic. Log the error, alert on it, but keep the API serving. If strict enforcement is required, fail closed — change `c.Next()` to `c.AbortWithStatus(503)` in the Redis error paths.

**Registration example:**

```go
// main.go
done := make(chan struct{})
defer close(done)

r.Use(middleware.FallbackRateLimiter(
    middleware.RedisTokenBucketConfig{
        Client:    rdb,
        Capacity:  100,
        Rate:      10,
        KeyPrefix: "rl:api:",
    },
    middleware.MemoryRateLimiterConfig{
        Rate:  10,
        Burst: 20,
    },
    done,
))
```
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: 322kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 322kUpdated 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: 322kUpdated 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: 322kUpdated Claude CodeCodexVerifiedInstall