middleware

Documentation

Index

• Variables
• func CORS() gin.HandlerFunc
• func CORSWithConfig(cfg CORSConfig) gin.HandlerFunc
• func Limit(cfg LimiterConfig) gin.HandlerFunc
• func Logger(notlogged ...string) gin.HandlerFunc
• type CORSConfig
• type LimiterConfig

Variables

var (
	// DefaultCORSConfig is the default CORS middleware config.
	DefaultCORSConfig = CORSConfig{
		AllowOrigins: []string{"*"},
		AllowMethods: []string{http.MethodGet, http.MethodHead, http.MethodPut, http.MethodPatch, http.MethodPost, http.MethodDelete},
	}
)

Functions

func CORS

func CORS() gin.HandlerFunc

CORS returns a Cross-Origin Resource Sharing (CORS) middleware. See: https://developer.mozilla.org/en/docs/Web/HTTP/Access_control_CORS

func CORSWithConfig

func CORSWithConfig(cfg CORSConfig) gin.HandlerFunc

CORSWithConfig returns a CORS middleware with config. See: `CORS()`.

func Limit

func Limit(cfg LimiterConfig) gin.HandlerFunc

func Logger

func Logger(notlogged ...string) gin.HandlerFunc

Types

type CORSConfig

type CORSConfig struct {
	// AllowOrigin defines a list of origins that may access the resource.
	// Optional. Default value []string{"*"}.
	AllowOrigins []string `yaml:"allow_origins" json:"allow_origins"`

	// AllowOriginFunc is a custom function to validate the origin. It takes the
	// origin as an argument and returns true if allowed or false otherwise. If
	// an error is returned, it is returned by the handler. If this option is
	// set, AllowOrigins is ignored.
	// Optional.
	AllowOriginFunc func(origin string) (bool, error) `yaml:"allow_origin_func" json:"allow_origin_func"`

	// AllowMethods defines a list methods allowed when accessing the resource.
	// This is used in response to a preflight request.
	// Optional. Default value DefaultCORSConfig.AllowMethods.
	AllowMethods []string `yaml:"allow_methods" json:"allow_methods"`

	// AllowHeaders defines a list of request headers that can be used when
	// making the actual request. This is in response to a preflight request.
	// Optional. Default value []string{}.
	AllowHeaders []string `yaml:"allow_headers" json:"allow_headers"`

	// AllowCredentials indicates whether or not the response to the request
	// can be exposed when the credentials flag is true. When used as part of
	// a response to a preflight request, this indicates whether or not the
	// actual request can be made using credentials.
	// Optional. Default value false.
	AllowCredentials bool `default:"false" yaml:"allow_credentials" json:"allow_credentials"`

	// ExposeHeaders defines a whitelist headers that clients are allowed to
	// access.
	// Optional. Default value []string{}.
	ExposeHeaders []string `yaml:"expose_headers" json:"expose_headers"`

	// MaxAge indicates how long (in seconds) the results of a preflight request
	// can be cached.
	// Optional. Default value 0.
	MaxAge int `default:"0" yaml:"max_age" json:"max_age"`
}

type LimiterConfig

type LimiterConfig struct {
	Rate  int           `default:"10"`
	Burst int           `default:"2"`
	TTL   time.Duration `default:"10m"`
}