Help us shape the future of Go! Take the 2026 Go Developer Survey

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

httpsvr

package

Go to main page

Versions in this module

v1

v1.1.1

Oct 28, 2022

Changes in this version

type GinEngineConf

+ func NewDefaultGinEngineConf() *GinEngineConf

+ func NewOnlyHttpGinEngineConf() *GinEngineConf

+ func NewOnlyMetricsGinEngineConf() *GinEngineConf

type GinEngineMiddlewareOpts

+ GrpcSvrMiddleware struct{ ... }

+ HttpSvrMiddleware []gin.HandlerFunc

type HttpServerConf

+ GrpcClientIdleTimeout uint32

+ GrpcClientPingMinIntervalTime uint32

+ GrpcConnAgeGraceTimeout uint32

+ HttpReadHeaderTimeout uint32

+ HttpReadTimeout uint32

+ HttpWriteTimeout uint32

v1.1.0

Oct 26, 2022

Changes in this version

type GinEngine

+ func (ge *GinEngine) GetGrpcServer() *grpc.Server

+ func (ge *GinEngine) GetHttpRegisteredGroup(path string) (*gin.RouterGroup, error)

+ func (ge *GinEngine) GrpcServiceRegistry(services ...GrpcRegisteredServiceItem)

+ func (ge *GinEngine) HttpMiddlewareRegistry(middleware ...gin.HandlerFunc)

+ func (ge *GinEngine) HttpRouteGroupRegistry(path string, baseGroup *gin.RouterGroup)

+ func (ge *GinEngine) HttpServiceRegistry(services ...httpServiceInterface)

type GinEngineFeatureOpts

+ EnableGrpc bool

+ type GinEngineMiddlewareOpts struct

+ type GrpcRegisteredServiceItem struct

+ ServiceDesc *grpc.ServiceDesc

+ ServiceServer interface{}

v1.0.0

Oct 25, 2022

Changes in this version

+ const ConstHttpHealthCheckUrlPath

+ const ConstPromMetricUrlPath

+ const ConstRootUrlPath

+ const ConstSwaggerUrlPath

+ var RouteNoRegisteredError = errors.New("router group not registered")

+ func PromHandler(handler http.Handler) gin.HandlerFunc

+ type BaseHttpService struct

+ func NewBaseHttpService(f func(*gin.RouterGroup)) *BaseHttpService

+ func (bhs *BaseHttpService) RoutesRegistry(ge *GinEngine)

+ type GinEngine struct

+ RootRouteGroup *gin.RouterGroup

+ func NewGinEngine(name string, engineConf *GinEngineConf, httpConf *HttpServerConf) *GinEngine

+ func (ge *GinEngine) Close()

+ func (ge *GinEngine) GetRegisteredGroup(path string) (*gin.RouterGroup, error)

+ func (ge *GinEngine) InitializeRoutes()

+ func (ge *GinEngine) IsReleaseMode() bool

+ func (ge *GinEngine) MiddlewareRegistry(middleware ...gin.HandlerFunc)

+ func (ge *GinEngine) RouteGroupRegistry(path string, baseGroup *gin.RouterGroup)

+ func (ge *GinEngine) RunAndService()

+ func (ge *GinEngine) ServiceRegistry(services ...serviceInterface)

+ type GinEngineConf struct

+ FeatureOpts GinEngineFeatureOpts

+ NoMatchHandlers GinEngineNoMatchHandlers

+ func NewStrictRestApiGinEngineConf() *GinEngineConf

+ func NewStrictRestApiReleaseModeGinEngineConf() *GinEngineConf

+ type GinEngineFeatureOpts struct

+ EnableGinRedirectFixedPath bool

+ EnableGinRedirectTrailingSlash bool

+ EnableHttpHealthCheck bool

+ EnableHttpPProf bool

+ EnablePrometheusMetrics bool

+ EnablePrometheusRoute bool

+ EnableSwagger bool

+ type GinEngineNoMatchHandlers = struct

+ NoMethodHandlers []gin.HandlerFunc

+ NoRouteHandlers []gin.HandlerFunc

+ type GinHttpProfService struct

+ func NewGinHttpProfService() *GinHttpProfService

+ func (gp GinHttpProfService) RoutesRegistry(ge *GinEngine)

+ type HttpServerConf struct

+ Address string

+ DisableKeepalive bool

+ Port uint16

+ ReadHeaderTimeout uint32

+ ReadTimeout uint32

+ WriteTimeout uint32

+ type PromOpts struct

+ ExcludeRegexAppName string

+ ExcludeRegexClientIp string

+ ExcludeRegexMethod string

+ ExcludeRegexStatus string

+ ExcludeRegexUrlPath string

+ UrlPathLabelMappingFn requestLabelMappingFn