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/background-jobs-queue-and-shutdown.md

View on GitHub
# Background Jobs — DB-Backed Queue, External Queue & Graceful Shutdown

See also: `background-jobs-goroutine-and-pool.md`

## Database-Backed Job Queue

For persistence across restarts and guaranteed at-least-once processing.

**Jobs table (PostgreSQL):**

```sql
CREATE TABLE jobs (
    id           UUID PRIMARY KEY DEFAULT gen_random_uuid(),
    type         TEXT NOT NULL,
    payload      JSONB NOT NULL,
    status       TEXT NOT NULL DEFAULT 'pending',  -- pending | running | done | failed
    attempts     INT NOT NULL DEFAULT 0,
    max_attempts INT NOT NULL DEFAULT 3,
    created_at   TIMESTAMPTZ NOT NULL DEFAULT now(),
    locked_at    TIMESTAMPTZ
);

CREATE INDEX ON jobs (status, locked_at) WHERE status = 'pending';
```

**Polling worker — claims with atomic UPDATE to prevent double-processing:**

```go
// internal/worker/db_worker.go
func (w *DBWorker) claimNext(ctx context.Context) (*Job, error) {
    var job Job
    err := w.db.QueryRowContext(ctx, `
        UPDATE jobs SET status = 'running', locked_at = now(), attempts = attempts + 1
        WHERE id = (
            SELECT id FROM jobs
            WHERE status = 'pending'
              AND attempts < max_attempts
              AND locked_at IS NULL
            ORDER BY created_at
            FOR UPDATE SKIP LOCKED
            LIMIT 1
        )
        RETURNING id, type, payload, attempts
    `).Scan(&job.ID, &job.Type, &job.Payload, &job.Attempts)
    if errors.Is(err, sql.ErrNoRows) {
        return nil, nil
    }
    return &job, err
}

func (w *DBWorker) Start(ctx context.Context) {
    ticker := time.NewTicker(5 * time.Second)
    defer ticker.Stop()

    for {
        select {
        case <-ticker.C:
            job, err := w.claimNext(ctx)
            if err != nil {
                w.logger.Error("claim job failed", "err", err)
                continue
            }
            if job == nil {
                continue
            }
            go w.process(ctx, job)
        case <-ctx.Done():
            return
        }
    }
}
```

Retry with exponential backoff: on failure set `status = 'pending'`, `locked_at = NULL`. After `max_attempts` set `status = 'failed'` (dead letter).

---

## External Queue (Brief)

Use when you need multiple workers, guaranteed delivery, or complex retry logic.

**`github.com/hibiken/asynq`** — Redis-backed task queue, drop-in for most use cases:

```go
// Enqueue (in handler)
client := asynq.NewClient(asynq.RedisClientOpt{Addr: redisAddr})
task := asynq.NewTask("email:welcome", payload)
_, err = client.EnqueueContext(c.Request.Context(), task)

// Worker (in main.go)
srv := asynq.NewServer(asynq.RedisClientOpt{Addr: redisAddr}, asynq.Config{Concurrency: 10})
mux := asynq.NewServeMux()
mux.HandleFunc("email:welcome", emailHandler.ProcessWelcome)
srv.Run(mux)
```

Use NATS or RabbitMQ when you need fan-out, pub/sub, or cross-service messaging.

---

## Graceful Shutdown

Stop accepting new jobs and drain in-flight work before process exit.

```go
// cmd/api/main.go
ctx, cancel := context.WithCancel(context.Background())

go worker.Start(ctx)

quit := make(chan os.Signal, 1)
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
<-quit

slog.Info("shutting down, draining jobs...")
cancel()                        // signals worker to stop and drain
time.Sleep(5 * time.Second)    // give in-flight jobs time to finish
slog.Info("shutdown complete")
```

For the DB-backed worker, the drain loop finishes processing claimed jobs even after `ctx` is cancelled before releasing the process.
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