httpserver

Mar 19, 2026

Changes in this version

+ var ErrInvalidConfig = errors.New("invalid config")

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

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

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

+ func HandleNoContent[Req any](fn ActionFunc[Req], opts ...HandlerOption) gin.HandlerFunc

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

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

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

+ func RealIPMiddleware() gin.HandlerFunc

+ func RealIPMiddlewareWithConfig(config httpmiddleware.RealIPConfig) gin.HandlerFunc

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

type Config

+ DrainTimeout time.Duration

+ LivenessPath string

+ ReadHeaderTimeout time.Duration

+ ReadinessPath string

+ func (c *Config) Normalize()

+ func (c *Config) Validate() error

+ type ErrorResponse struct

+ Code string

+ Details map[string]any

+ Message string

+ type HTTPError interface

+ ErrorCode func() string

+ ErrorDetails func() map[string]any

+ ErrorMessage func() string

+ StatusCode func() int

+ type HTTPServerMutator func(*http.Server)

type HandlerOption

+ func WithValidators[Req any](validators ...RequestValidator[Req]) HandlerOption

+ type HealthCheckOption func(*HealthCheckManager)

+ func WithCheckTimeout(timeout time.Duration) HealthCheckOption

type Hooks

+ OnStateChange func(ctx context.Context, from State, to State)

type Option

+ func WithHTTPServerMutator(mutator HTTPServerMutator) Option

+ func WithManualReadiness() Option

+ type RequestValidator func(context.Context, Req) error

type Server

+ func (s *Server) HealthAddr() string

+ func (s *Server) MarkDraining() error

+ func (s *Server) MarkReady() error

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

+ func (s *Server) State() State

+ type State string

+ const StateDraining

+ const StateFailed

+ const StateNew

+ const StateReady

+ const StateStarting

+ const StateStopped

+ const StateStopping

+ type ValidationError struct

+ Fields []ValidationField

+ Message string

+ func (e *ValidationError) Error() string

+ type ValidationField struct

+ Code string

+ Field string

+ Message string

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

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)

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