Rene Nochebuena
f0ff3c38ed
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>
34 lines
1.2 KiB
Go
34 lines
1.2 KiB
Go
// Package web provides the HTTP foundation for Einherjar services.
|
|
//
|
|
// The root package exposes [New] — a factory that returns a lifecycle-managed
|
|
// chi server with the recommended middleware stack pre-applied (request ID,
|
|
// panic recovery, request logging). Import the sub-packages directly for full
|
|
// control over individual components.
|
|
//
|
|
// Sub-packages:
|
|
//
|
|
// - [code.nochebuena.dev/einherjar/web/server] — lifecycle-managed chi HTTP server
|
|
// - [code.nochebuena.dev/einherjar/web/mw] — transport middleware: recover, CORS, request ID, request logger, rate limiting
|
|
// - [code.nochebuena.dev/einherjar/web/httputil] — typed handler adapters and HTTP response helpers
|
|
// - [code.nochebuena.dev/einherjar/web/health] — concurrent health check handler
|
|
//
|
|
// # Happy path
|
|
//
|
|
// logger := logz.New(logz.Config{JSON: true})
|
|
// lc := launcher.New(logger)
|
|
//
|
|
// srv := web.New(logger)
|
|
// srv.Get("/health", health.NewHandler(logger, db, cache).ServeHTTP)
|
|
//
|
|
// lc.Append(srv)
|
|
// lc.BeforeStart(func() error {
|
|
// // register routes
|
|
// return nil
|
|
// })
|
|
//
|
|
// if err := lc.Run(); err != nil {
|
|
// logger.Error("launcher failed", err)
|
|
// os.Exit(1)
|
|
// }
|
|
package web
|