handler

package

v1.6.42 Latest Latest Go to latest Published: Jul 24, 2024 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ZYallers/zgin

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ExpHandler(ctx *gin.Context)
func GoVersion() interface{}
func PProfRegister(r *gin.Engine, prefixOptions ...string)
func PrometheusHandler(ctx *gin.Context, name string)
func RouteRegister(rg *gin.RouterGroup, prefixOptions ...string)
func StatsHandler(ctx *gin.Context)
func SwagHandler(ctx *gin.Context)
func WithExpVar() option.App
func WithHealth() option.App
func WithNoRoute() option.App
func WithPProf() option.App
func WithPing() option.App
func WithPrometheus() option.App
func WithRootPath() option.App
func WithStats(acts gin.Accounts) option.App
func WithSwagger() option.App

Constants ¶

View Source

const (
	// DefaultPrefix url prefix of pprof
	DefaultPrefix = "/debug/pprof"
)

Variables ¶

This section is empty.

Functions ¶

func PProfRegister ¶

func PProfRegister(r *gin.Engine, prefixOptions ...string)

Register the standard HandlerFuncs from the net/http/pprof package with the provided gin.Engine. prefixOptions is a optional. If not prefixOptions, the default path prefix is used, otherwise first prefixOptions will be path prefix.

func PrometheusHandler ¶

func PrometheusHandler(ctx *gin.Context, name string)

func RouteRegister ¶

func RouteRegister(rg *gin.RouterGroup, prefixOptions ...string)

RouteRegister the standard HandlerFuncs from the net/http/pprof package with the provided gin.GrouterGroup. prefixOptions is a optional. If not prefixOptions, the default path prefix is used, otherwise first prefixOptions will be path prefix.

func StatsHandler ¶

func StatsHandler(ctx *gin.Context)

func SwagHandler ¶

func SwagHandler(ctx *gin.Context)

func WithExpVar ¶ added in v1.5.0

func WithExpVar() option.App

func WithHealth ¶ added in v1.5.0

func WithHealth() option.App

func WithNoRoute ¶ added in v1.5.0

func WithNoRoute() option.App

func WithPProf ¶ added in v1.5.0

func WithPProf() option.App

func WithPing ¶ added in v1.5.0

func WithPing() option.App

func WithPrometheus ¶ added in v1.5.0

func WithPrometheus() option.App

func WithRootPath ¶ added in v1.5.0

func WithRootPath() option.App

func WithStats ¶ added in v1.5.0

func WithStats(acts gin.Accounts) option.App

func WithSwagger ¶ added in v1.5.0

func WithSwagger() option.App

Types ¶