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/websocket-hub-and-client.md

View on GitHub
# WebSocket — Hub Pattern & Client readPump/writePump

See also: `websocket-setup-and-echo.md`, `websocket-auth-and-keepalive.md`, `websocket-shutdown-and-messages.md`, `websocket-testing.md`, `websocket-chat-handler.md`

## Hub Pattern

For broadcasting to multiple clients (chat rooms, live feeds), a central hub serializes all register/unregister/broadcast operations through a single goroutine — avoiding mutex-protected maps.

```go
// internal/ws/hub.go
package ws

type Hub struct {
    clients    map[*Client]bool
    broadcast  chan []byte
    register   chan *Client
    unregister chan *Client
}

func NewHub() *Hub {
    return &Hub{
        clients:    make(map[*Client]bool),
        broadcast:  make(chan []byte, 256),
        register:   make(chan *Client),
        unregister: make(chan *Client),
    }
}

// Run processes hub events. Call this in a dedicated goroutine.
func (h *Hub) Run() {
    for {
        select {
        case client := <-h.register:
            h.clients[client] = true

        case client := <-h.unregister:
            if _, ok := h.clients[client]; ok {
                delete(h.clients, client)
                close(client.send)
            }

        case message := <-h.broadcast:
            for client := range h.clients {
                select {
                case client.send <- message:
                default:
                    // send buffer full — client is too slow; drop and disconnect.
                    close(client.send)
                    delete(h.clients, client)
                }
            }
        }
    }
}
```

**Why channel-based (not mutex):** The hub goroutine owns the `clients` map exclusively. No locking needed. The `default` branch in broadcast prevents a slow client from blocking the entire broadcast loop.

---

## Client Struct with readPump / writePump

Two goroutines per client: `readPump` reads from the WebSocket, `writePump` writes to it. This avoids concurrent writes to `*websocket.Conn` (gorilla/websocket does not allow them).

```go
// internal/ws/client.go
package ws

import (
    "log/slog"
    "time"

    "github.com/gin-gonic/gin"
    "github.com/gorilla/websocket"
)

const (
    writeWait      = 10 * time.Second
    pongWait       = 60 * time.Second
    pingPeriod     = (pongWait * 9) / 10
    maxMessageSize = 512 * 1024
)

type Client struct {
    hub  *Hub
    conn *websocket.Conn
    send chan []byte
}

func (cl *Client) readPump() {
    defer func() {
        cl.hub.unregister <- cl
        cl.conn.Close()
    }()

    cl.conn.SetReadLimit(maxMessageSize)
    cl.conn.SetReadDeadline(time.Now().Add(pongWait))
    cl.conn.SetPongHandler(func(string) error {
        cl.conn.SetReadDeadline(time.Now().Add(pongWait))
        return nil
    })

    for {
        _, msg, err := cl.conn.ReadMessage()
        if err != nil {
            if websocket.IsUnexpectedCloseError(err,
                websocket.CloseGoingAway,
                websocket.CloseNormalClosure,
            ) {
                slog.Warn("ws read error", "err", err)
            }
            return
        }
        cl.hub.broadcast <- msg
    }
}

func (cl *Client) writePump() {
    ticker := time.NewTicker(pingPeriod)
    defer func() {
        ticker.Stop()
        cl.conn.Close()
    }()

    for {
        select {
        case msg, ok := <-cl.send:
            cl.conn.SetWriteDeadline(time.Now().Add(writeWait))
            if !ok {
                cl.conn.WriteMessage(websocket.CloseMessage, []byte{})
                return
            }
            if err := cl.conn.WriteMessage(websocket.TextMessage, msg); err != nil {
                slog.Warn("ws write error", "err", err)
                return
            }

        case <-ticker.C:
            cl.conn.SetWriteDeadline(time.Now().Add(writeWait))
            if err := cl.conn.WriteMessage(websocket.PingMessage, nil); err != nil {
                return
            }
        }
    }
}

```

See also: `websocket-chat-handler.md` for `ChatHandler` wiring.
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