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

View on GitHub
# File Uploads — Cloud Storage (S3) & Security Checklist

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

## S3 / Cloud Storage

Define a storage interface so handlers stay decoupled from the provider:

```go
// internal/storage/storage.go
type FileStorage interface {
    Upload(ctx context.Context, file *multipart.FileHeader) (url string, err error)
    PresignedURL(ctx context.Context, key string, ttl time.Duration) (string, error)
}
```

```go
// internal/storage/s3_storage.go
type S3Storage struct {
    client *s3.Client
    bucket string
    logger *slog.Logger
}

func (s *S3Storage) Upload(ctx context.Context, file *multipart.FileHeader) (string, error) {
    src, err := file.Open()
    if err != nil {
        return "", fmt.Errorf("open file: %w", err)
    }
    defer src.Close()

    key := uuid.NewString() + "_" + filepath.Base(file.Filename)

    _, err = s.client.PutObject(ctx, &s3.PutObjectInput{
        Bucket:      aws.String(s.bucket),
        Key:         aws.String(key),
        Body:        src,
        ContentType: aws.String(file.Header.Get("Content-Type")),
    })
    if err != nil {
        return "", fmt.Errorf("s3 put object: %w", err)
    }

    return fmt.Sprintf("https://%s.s3.amazonaws.com/%s", s.bucket, key), nil
}

func (s *S3Storage) PresignedURL(ctx context.Context, key string, ttl time.Duration) (string, error) {
    presignClient := s3.NewPresignClient(s.client)
    req, err := presignClient.PresignGetObject(ctx, &s3.GetObjectInput{
        Bucket: aws.String(s.bucket),
        Key:    aws.String(key),
    }, s3.WithPresignExpires(ttl))
    if err != nil {
        return "", fmt.Errorf("presign: %w", err)
    }
    return req.URL, nil
}
```

Local filesystem fallback for development — implement `FileStorage` writing to disk.

## Security Checklist

| Risk | Mitigation |
|------|-----------|
| Directory traversal | `filepath.Base(file.Filename)` strips all path components |
| MIME spoofing | Detect MIME from first 512 bytes with `http.DetectContentType`; never trust `Content-Type` header |
| Oversized files | `router.MaxMultipartMemory` + explicit `file.Size` check in handler |
| Filename collision | Prefix with `uuid.NewString()` |
| Serving uploaded files | Store outside webroot; serve through signed URLs or a dedicated file handler |
| Malware | Integrate ClamAV or cloud AV scan before persisting in production |
| Path exposure | Never return filesystem paths; return opaque keys or signed URLs |
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