Files
web/mw/doc.go
T
Rene Nochebuena f0ff3c38ed docs(web): fix non-compiling doc examples; bump to v1.1.0 (#1)
Coordinated framework release. Documentation-only code changes plus the shared
version bump (folds the never-tagged 1.0.1 contracts pin into 1.1.0).

- mw.Recover() -> mw.Recover(logger): web/mw/doc.go, web/server/doc.go,
  web/server/server.go.
- health.NewHandler(...) -> ....ServeHTTP (chi Get takes HandlerFunc): web/server/doc.go,
  web/doc.go, web/health/doc.go.
- go.mod: contracts, core -> v1.1.0 (via go get + go mod tidy).

Verified by compiling the example patterns against the real API. Badge -> v1.1.0.

Reviewed-on: #1
Co-authored-by: Rene Nochebuena Guerrero <rene@nochebuena.dev>
Co-committed-by: Rene Nochebuena Guerrero <rene@nochebuena.dev>
2026-08-07 19:07:57 -06:00

25 lines
793 B
Go

// Package mw provides transport-level HTTP middleware for Einherjar services.
//
// All middleware functions return func(http.Handler) http.Handler and are
// composed via [server.WithMiddleware] or chi's Use method.
//
// # Recommended middleware order (outermost first)
//
// server.WithMiddleware(
// mw.Recover(logger),
// mw.RequestID(uuid.NewString),
// mw.RequestLogger(logger),
// mw.CORS([]string{"https://example.com"}),
// )
//
// # Rate limiting
//
// // In-memory (default — no extra dependencies)
// store := mw.NewInMemoryRateLimiterStore(100, 20)
// srv.Use(mw.IPRateLimit(store, logger))
//
// // Distributed — swap store, middleware unchanged
// store := valkeymw.NewRateLimiterStore(client, 100, 20)
// srv.Use(mw.IPRateLimit(store, logger))
package mw