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
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.3.4

Mar 17, 2026

v1.3.3

Mar 17, 2026

v1.3.2

Mar 13, 2026

v1.3.1

Mar 10, 2026

v1.3.0

Mar 10, 2026

Changes in this version

+ func ComposeDecoder[Req any](decoders ...func(*gin.Context, *Req) error) func(*gin.Context, *Req) error

+ func DecodeJSON[Req any]() func(*gin.Context, *Req) error

+ func DecodeQuery[Req any]() func(*gin.Context, *Req) error

+ func DecodeURI[Req any]() func(*gin.Context, *Req) error

+ func HandleJSON[Req any, Resp any](fn HandlerFunc[Req, Resp], opts ...HandlerOption) gin.HandlerFunc

+ func Handle[Req any, Resp any](fn HandlerFunc[Req, Resp], opts ...HandlerOption) gin.HandlerFunc

+ type ErrorMapper func(err error) (status int, body any)

+ type HandlerFunc func(ctx context.Context, req Req) (Resp, error)

+ type HandlerOption func(*handlerConfig)

+ func WithDecoder[Req any](decoder func(*gin.Context, *Req) error) HandlerOption

+ func WithEncoder(encoder func(*gin.Context, int, any)) HandlerOption

+ func WithErrorMapper(mapper ErrorMapper) HandlerOption

+ func WithSuccessStatus(status int) HandlerOption

+ type Hooks struct

+ OnServeError func(context.Context, LifecycleEvent)

+ OnShutdownComplete func(context.Context, LifecycleEvent)

+ OnShuttingDown func(context.Context, LifecycleEvent)

+ OnStarted func(context.Context, LifecycleEvent)

+ OnStarting func(context.Context, LifecycleEvent)

+ type LifecycleEvent struct

+ Addr string

+ Err error

+ HealthAddr string

+ type Option func(*Server)

+ func WithHooks(h Hooks) Option

+ func WithModules(modules ...RouteModule) Option

+ type RouteModule interface

+ RegisterRoutes func(r gin.IRoutes)

type Server

+ func (s *Server) Errors() <-chan error

+ func (s *Server) RegisterModules(modules ...RouteModule)

+ func (s *Server) Serve(ln net.Listener) error

v1.2.1

Mar 10, 2026

v1.2.0

Mar 9, 2026

v1.1.1

Mar 9, 2026

v1.1.0

Mar 9, 2026

v1.0.2

Dec 24, 2025

Changes in this version

+ func DefaultHealthHandler() gin.HandlerFunc

+ func HealthHandlerWithManager(manager *HealthCheckManager) gin.HandlerFunc

type Config

+ EnableHealthCheck bool

+ HealthCheckPath string

+ HealthCheckPort int

+ type CustomHealthChecker struct

+ func NewCustomHealthChecker(name string, checker func(ctx context.Context) error) *CustomHealthChecker

+ func (chc *CustomHealthChecker) CheckHealth(ctx context.Context) error

+ func (chc *CustomHealthChecker) GetName() string

+ type DatabaseHealthChecker struct

+ func NewDatabaseHealthChecker(name string, db interface{ ... }) *DatabaseHealthChecker

+ func (dhc *DatabaseHealthChecker) CheckHealth(ctx context.Context) error

+ func (dhc *DatabaseHealthChecker) GetName() string

+ type HTTPHealthChecker struct

+ func NewHTTPHealthChecker(name, url string, timeout time.Duration) *HTTPHealthChecker

+ func (hhc *HTTPHealthChecker) CheckHealth(ctx context.Context) error

+ func (hhc *HTTPHealthChecker) GetName() string

+ type HealthCheckManager struct

+ func NewHealthCheckManager(version string) *HealthCheckManager

+ func (hcm *HealthCheckManager) AddChecker(checker HealthChecker)

+ func (hcm *HealthCheckManager) CheckHealth(ctx context.Context) *HealthStatus

+ type HealthChecker interface

+ CheckHealth func(ctx context.Context) error

+ GetName func() string

+ type HealthStatus struct

+ Checks map[string]interface{}

+ Error string

+ Status string

+ Timestamp int64

+ Uptime int64

+ Version string

type Server

+ func (s *Server) EnableHealthCheck()

+ func (s *Server) EnableHealthCheckWithManager(manager *HealthCheckManager)

+ func (s *Server) GetHealthCheckPath() string

+ func (s *Server) SetHealthCheckPath(path string)

v1.0.1-beta.1

Oct 22, 2025

v1.0.0

Jul 25, 2025

Changes in this version

+ func CORSMiddleware() gin.HandlerFunc

+ func ContextFromGin(c *gin.Context) context.Context

+ func GetRequestID(c *gin.Context) string

+ func GetTraceID(c *gin.Context) string

+ func RequestIDMiddleware() gin.HandlerFunc

+ func TraceIDMiddleware() gin.HandlerFunc

+ type Config struct

+ Host string

+ IdleTimeout time.Duration

+ MaxHeaderBytes int

+ Port int

+ ReadTimeout time.Duration

+ ShutdownTimeout time.Duration

+ WriteTimeout time.Duration

+ func DefaultConfig() *Config

+ type Server struct

+ func NewServer(config *Config) *Server

+ func (s *Server) Addr() string

+ func (s *Server) Any(relativePath string, handlers ...gin.HandlerFunc)

+ func (s *Server) DELETE(relativePath string, handlers ...gin.HandlerFunc)

+ func (s *Server) Engine() *gin.Engine

+ func (s *Server) GET(relativePath string, handlers ...gin.HandlerFunc)

+ func (s *Server) Group(relativePath string, handlers ...gin.HandlerFunc) *gin.RouterGroup

+ func (s *Server) HEAD(relativePath string, handlers ...gin.HandlerFunc)

+ func (s *Server) IsRunning() bool

+ func (s *Server) OPTIONS(relativePath string, handlers ...gin.HandlerFunc)

+ func (s *Server) PATCH(relativePath string, handlers ...gin.HandlerFunc)

+ func (s *Server) POST(relativePath string, handlers ...gin.HandlerFunc)

+ func (s *Server) PUT(relativePath string, handlers ...gin.HandlerFunc)

+ func (s *Server) RegisterRoutes(routes func(r *gin.Engine))

+ func (s *Server) Run() error

+ func (s *Server) RunTLS(certFile, keyFile string) error

+ func (s *Server) RunWithGracefulShutdown() error

+ func (s *Server) Shutdown(ctx context.Context) error

+ func (s *Server) Start() error

+ func (s *Server) Use(middleware ...gin.HandlerFunc)

+ func (s *Server) WaitForShutdown() error