healthchek

Documentation

Index

• Variables
• func Default() gin.HandlerFunc
• func New(cfg Config) gin.HandlerFunc
• type Config

Variables

var (
	// DefaultHeaderName default header name
	DefaultHeaderName = "X-Health-Check"

	// DefaultHeaderValue default header value
	DefaultHeaderValue = "1"

	// DefaultResponseCode default response code
	DefaultResponseCode = http.StatusOK

	// DefaultResponseText default response text
	DefaultResponseText = "ok"

	// DefaultConfig default config
	DefaultConfig = Config{
		HeaderName:   DefaultHeaderName,
		HeaderValue:  DefaultHeaderValue,
		ResponseCode: DefaultResponseCode,
		ResponseText: DefaultResponseText}
)

Functions

func Default

func Default() gin.HandlerFunc

Default creates a new middileware with the default configuration

func New

func New(cfg Config) gin.HandlerFunc

New creates a new middileware with the `cfg`

Types

type Config

type Config struct {
	HeaderName   string
	HeaderValue  string
	ResponseCode int
	ResponseText string
}

Config holds the configuration values