Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

httpserver

package

Go to main page

Versions in this module

v1

v1.148.2

Jul 11, 2026

v1.148.1

Jul 11, 2026

v1.148.0

Jul 11, 2026

v1.147.1

Jul 11, 2026

v1.147.0

Jul 11, 2026

v1.146.0

Jul 11, 2026

Changes in this version

+ const DisableTimeout

+ var ErrDuplicateRoute = errors.New("duplicate route")

+ var ErrInvalidRouteMethod = errors.New("invalid route method")

+ var ErrInvalidRoutePath = errors.New("invalid route path")

+ var ErrInvalidTLSConfig = errors.New(...)

+ var ErrNilBinder = errors.New("binder is required")

+ var ErrNilRouteHandler = errors.New("route handler is required")

+ var ErrNilRouteMiddleware = errors.New("route middleware function is required")

+ var ErrRouteRegistration = errors.New("route registration failed")

+ var ErrUnknownDefaultRoute = errors.New("unknown default route")

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

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

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

+ 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) Addr() net.Addr

+ func (h *HTTPServer) ServeError() <-chan 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 *slog.Logger

+ Method string

+ Path string

+ RedactFunc RedactFn

+ Rnd *random.Rnd

+ 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 WithLogger(logger *slog.Logger) Option

+ func WithMaxRequestBodyBytes(n int64) 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 WithServerIdleTimeout(timeout time.Duration) Option

+ func WithServerMaxHeaderBytes(n int) 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 WithTLSConfig(tlsConfig *tls.Config) Option

+ func WithTraceIDHeaderName(name string) Option

+ func WithoutDefaultRouteLogger(routes ...DefaultRoute) Option

+ func WithoutMethodNotAllowedLogger() Option

+ func WithoutNotFoundLogger() Option

+ func WithoutRouteLogger() Option

+ type RedactFn func(b []byte) string

+ type Route struct

+ Description string

+ DisableLogger bool

+ Handler http.HandlerFunc

+ Method string

+ Middleware []MiddlewareFn

+ Path string

+ Timeout time.Duration