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/routing-validators-and-limits.md

View on GitHub
# Routing — Custom Validators & Request Size Limits

See also: `routing-groups-and-versioning.md`, `routing-params-and-wildcards.md`

## Custom Validators

Register custom validators via the `go-playground/validator/v10` engine. Do this once at startup.

```go
// pkg/validation/validators.go
package validation

import (
    "fmt"
    "time"

    "github.com/gin-gonic/gin/binding"
    "github.com/go-playground/validator/v10"
    "github.com/google/uuid"
)

func Register() error {
    v, ok := binding.Validator.Engine().(*validator.Validate)
    if !ok {
        return fmt.Errorf("unexpected validator type")
    }

    if err := v.RegisterValidation("uuid", validateUUID); err != nil {
        return fmt.Errorf("register uuid validator: %w", err)
    }

    if err := v.RegisterValidation("future_ts", validateFutureTimestamp); err != nil {
        return fmt.Errorf("register future_ts validator: %w", err)
    }

    return nil
}

func validateUUID(fl validator.FieldLevel) bool {
    val := fl.Field().String()
    _, err := uuid.Parse(val)
    return err == nil
}

func validateFutureTimestamp(fl validator.FieldLevel) bool {
    ts := fl.Field().Int()
    return time.Unix(ts, 0).After(time.Now())
}
```

Register in main.go before starting the server:

```go
if err := validation.Register(); err != nil {
    logger.Error("failed to register validators", "error", err)
    os.Exit(1)
}
```

Usage in request struct:

```go
type ScheduleRequest struct {
    UserID    string `json:"user_id"    binding:"required,uuid"`
    StartTime int64  `json:"start_time" binding:"required,future_ts"`
}
```

---

## Request Size Limits

Limit request body size to protect against large payload attacks.

```go
// pkg/middleware/limits.go
package middleware

import (
    "net/http"
    "github.com/gin-gonic/gin"
)

// RequestSizeLimit returns middleware that limits request body size.
func RequestSizeLimit(maxBytes int64) gin.HandlerFunc {
    return func(c *gin.Context) {
        c.Request.Body = http.MaxBytesReader(c.Writer, c.Request.Body, maxBytes)
        c.Next()
    }
}
```

```go
// Apply globally (1 MB limit for all routes)
r.Use(middleware.RequestSizeLimit(1 << 20))

// Or per-route (10 MB for file upload route)
r.POST("/upload", middleware.RequestSizeLimit(10<<20), uploadHandler)
```

For multipart forms, also configure `engine.MaxMultipartMemory`:

```go
r := gin.New()
r.MaxMultipartMemory = 8 << 20 // 8 MB in-memory; rest spills to disk
```
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