gin

Documentation

Index

• func AddBasicHandlers(router *gin.Engine, config *MiddlewaresConfig, logger *logger.Logger) error
• type MiddlewaresConfig

Functions

func AddBasicHandlers

func AddBasicHandlers(router *gin.Engine, config *MiddlewaresConfig, logger *logger.Logger) error

AddBasicHandlers will add basic handlers required by a Server. Library Ref: https://github.com/gin-gonic/contrib

Types

type MiddlewaresConfig

type MiddlewaresConfig struct {
	DebugEnabled      bool
	PrometheusEnabled bool
	RateLimiterConfig struct {
		Enabled    bool
		Interval   time.Duration
		BucketSize int
	}
	SecureOptions struct {
		Enabled      bool
		AllowedHosts []string
		SSLHost      string
	}
	CorsOptions struct {
		Enabled         bool
		AllowOrigins    []string
		AllowMethods    []string
		AllowHeaders    []string
		ExposeHeader    []string
		AllowOriginFunc func(origin string) bool
		MaxAge          time.Duration
	}
	StaticFilesOptions struct {
		Enabled    bool
		ServeFiles []struct {
			Prefix                 string
			FilePath               string
			AllowDirectoryIndexing bool
		}
	}
	NewRelicOptions struct {
		ServiceName string
		LicenseKey  string
	}
}

MiddlewaresConfig is a set of middlewares related config params