gofconfmiddleware

Documentation

Index

• Variables
• func CORS(configs ...CORSConfig) gin.HandlerFunc
• type CORSConfig
  • func (p *CORSConfig) InitFunc() error

Variables

var (
	// DefaultCORSConfig is the default CORS middleware config.
	DefaultCORSConfig = CORSConfig{
		AllowOrigins:     []string{"*"},
		AllowMethods:     []string{"GET", "POST", "PUT", "PATCH", "HEAD", "DELETE"},
		AllowHeaders:     []string{},
		AllowCredentials: true,
		MaxAge:           172800,
	}
)

Functions

func CORS

func CORS(configs ...CORSConfig) gin.HandlerFunc

CORS ...

Types

type CORSConfig

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

	// 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 `mapstructure:"allow_methods" yaml:"allow_methods"`

	// AllowHeaders defines a list of request headers that can be used when
	// making the actual request. This in response to a preflight request.
	// Optional. Default value []string{}.
	AllowHeaders []string `mapstructure:"allow_headers" yaml:"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 `mapstructure:"allow_credentials" yaml:"allow_credentials"`

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

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

CORSConfig defines the config for CORS middleware.

func (*CORSConfig) InitFunc

func (p *CORSConfig) InitFunc() error

InitFunc ReadIn ...