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/file-uploads-local.md

View on GitHub
# File Uploads — Local Storage (Single, Multiple & Struct Binding)

See also: `file-uploads-cloud.md`

## Router Configuration

Always set `MaxMultipartMemory` before registering upload routes:

```go
// cmd/api/main.go
r := gin.New()
r.MaxMultipartMemory = 8 << 20 // 8 MiB in memory; remainder spills to temp files
```

## Single File Upload

```go
// internal/handler/upload_handler.go
func (h *UploadHandler) UploadFile(c *gin.Context) {
    file, err := c.FormFile("file")
    if err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": "file is required"})
        return
    }

    if err := validateFile(file); err != nil {
        c.JSON(http.StatusUnprocessableEntity, gin.H{"error": err.Error()})
        return
    }

    safeName := uuid.NewString() + "_" + filepath.Base(file.Filename)
    dst := filepath.Join(h.uploadDir, safeName)

    if err := c.SaveUploadedFile(file, dst); err != nil {
        h.logger.Error("save upload failed", "err", err)
        c.JSON(http.StatusInternalServerError, gin.H{"error": "upload failed"})
        return
    }

    c.JSON(http.StatusCreated, gin.H{"filename": safeName})
}

const maxFileSize = 10 << 20 // 10 MiB

var allowedMIME = map[string]bool{
    "image/jpeg":      true,
    "image/png":       true,
    "application/pdf": true,
}

func validateFile(file *multipart.FileHeader) error {
    if file.Size > maxFileSize {
        return fmt.Errorf("file exceeds 10 MiB limit")
    }

    src, err := file.Open()
    if err != nil {
        return fmt.Errorf("cannot open file")
    }
    defer src.Close()

    // Read first 512 bytes for MIME sniffing — do NOT trust file.Header["Content-Type"]
    buf := make([]byte, 512)
    if _, err := src.Read(buf); err != nil {
        return fmt.Errorf("cannot read file")
    }

    mimeType := http.DetectContentType(buf)
    if !allowedMIME[mimeType] {
        return fmt.Errorf("file type %q not allowed", mimeType)
    }

    return nil
}
```

## Multiple File Upload

```go
func (h *UploadHandler) UploadFiles(c *gin.Context) {
    form, err := c.MultipartForm()
    if err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": "invalid multipart form"})
        return
    }

    files := form.File["files[]"]
    if len(files) == 0 {
        c.JSON(http.StatusBadRequest, gin.H{"error": "no files provided"})
        return
    }

    var saved []string
    for _, file := range files {
        if err := validateFile(file); err != nil {
            c.JSON(http.StatusUnprocessableEntity, gin.H{"error": err.Error()})
            return
        }

        safeName := uuid.NewString() + "_" + filepath.Base(file.Filename)
        if err := c.SaveUploadedFile(file, filepath.Join(h.uploadDir, safeName)); err != nil {
            h.logger.Error("save upload failed", "file", file.Filename, "err", err)
            c.JSON(http.StatusInternalServerError, gin.H{"error": "upload failed"})
            return
        }
        saved = append(saved, safeName)
    }

    c.JSON(http.StatusCreated, gin.H{"filenames": saved})
}
```

## Struct Binding with File Field

`ShouldBind` resolves `*multipart.FileHeader` from `form` tags:

```go
type UploadRequest struct {
    Name        string                `form:"name"        binding:"required,max=100"`
    Description string                `form:"description" binding:"omitempty,max=500"`
    File        *multipart.FileHeader `form:"file"        binding:"required"`
}

func (h *UploadHandler) UploadWithMeta(c *gin.Context) {
    var req UploadRequest
    if err := c.ShouldBind(&req); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }

    if err := validateFile(req.File); err != nil {
        c.JSON(http.StatusUnprocessableEntity, gin.H{"error": err.Error()})
        return
    }

    url, err := h.storage.Upload(c.Request.Context(), req.File)
    if err != nil {
        h.logger.Error("storage upload failed", "err", err)
        c.JSON(http.StatusInternalServerError, gin.H{"error": "upload failed"})
        return
    }

    c.JSON(http.StatusCreated, gin.H{"url": url, "name": req.Name})
}
```
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