httpserver

Nov 11, 2025

Changes in this version

type Option

+ func WithLogger(logger *slog.Logger) Option

Nov 4, 2025

Changes in this version

+ func ApplyMiddleware(arg MiddlewareArgs, next http.Handler, middleware ...MiddlewareFn) http.Handler

+ func LoggerMiddlewareFn(args MiddlewareArgs, next http.Handler) http.Handler

+ func RequestInjectHandler(logger *zap.Logger, traceIDHeaderName string, redactFn RedactFn, ...) http.Handler

+ func Start(ctx context.Context, binder Binder, opts ...Option) error

+ type Binder interface

+ BindHTTP func(ctx context.Context) []Route

+ func NopBinder() Binder

+ type DefaultRoute string

+ const IPRoute

+ const IndexRoute

+ const MetricsRoute

+ const PingRoute

+ const PprofRoute

+ const StatusRoute

+ type GetPublicIPFunc func(context.Context) (string, error)

+ func GetPublicIPDefaultFunc() GetPublicIPFunc

+ type HTTPServer struct

+ func New(ctx context.Context, binder Binder, opts ...Option) (*HTTPServer, error)

+ func (h *HTTPServer) Shutdown(ctx context.Context) error

+ func (h *HTTPServer) StartServer()

+ func (h *HTTPServer) StartServerCtx(ctx context.Context)

+ type Index struct

+ Routes []Route

+ type IndexHandlerFunc func([]Route) http.HandlerFunc

+ type MiddlewareArgs struct

+ Description string

+ Logger *zap.Logger

+ Method string

+ Path string

+ RedactFunc RedactFn

+ TraceIDHeaderName string

+ type MiddlewareFn func(args MiddlewareArgs, next http.Handler) http.Handler

+ type Option func(*config) error

+ func WithEnableAllDefaultRoutes() Option

+ func WithEnableDefaultRoutes(ids ...DefaultRoute) Option

+ func WithIPHandlerFunc(handler http.HandlerFunc) Option

+ func WithIndexHandlerFunc(handler IndexHandlerFunc) Option

+ func WithMethodNotAllowedHandlerFunc(handler http.HandlerFunc) Option

+ func WithMetricsHandlerFunc(handler http.HandlerFunc) Option

+ func WithMiddlewareFn(fn ...MiddlewareFn) Option

+ func WithNotFoundHandlerFunc(handler http.HandlerFunc) Option

+ func WithPProfHandlerFunc(handler http.HandlerFunc) Option

+ func WithPanicHandlerFunc(handler http.HandlerFunc) Option

+ func WithPingHandlerFunc(handler http.HandlerFunc) Option

+ func WithRedactFn(fn RedactFn) Option

+ func WithRequestTimeout(timeout time.Duration) Option

+ func WithRouter(r *httprouter.Router) Option

+ func WithServerAddr(addr string) Option

+ func WithServerReadHeaderTimeout(timeout time.Duration) Option

+ func WithServerReadTimeout(timeout time.Duration) Option

+ func WithServerWriteTimeout(timeout time.Duration) Option

+ func WithShutdownSignalChan(ch chan struct{}) Option

+ func WithShutdownTimeout(timeout time.Duration) Option

+ func WithShutdownWaitGroup(wg *sync.WaitGroup) Option

+ func WithStatusHandlerFunc(handler http.HandlerFunc) Option

+ func WithTLSCertData(pemCert, pemKey []byte) Option

+ func WithTraceIDHeaderName(name string) Option

+ func WithoutDefaultRouteLogger(routes ...DefaultRoute) Option

+ func WithoutRouteLogger() Option

+ type RedactFn func(s string) string

+ type Route struct

+ Description string

+ DisableLogger bool

+ Handler http.HandlerFunc

+ Method string

+ Middleware []MiddlewareFn

+ Path string

+ Timeout time.Duration