cors

README

cors

EOL-warning

This package has been abandoned on 2016-12-07. Please use gin-contrib/cors instead.

Documentation

Index

• func Default() gin.HandlerFunc
• func New(config Config) gin.HandlerFunc
• type Config
  • func DefaultConfig() Config
  • func (c *Config) AddAllowedHeaders(headers ...string)
  • func (c *Config) AddAllowedMethods(methods ...string)
  • func (c *Config) AddExposedHeaders(headers ...string)
  • func (c Config) Validate() error

Functions

func Default

func Default() gin.HandlerFunc

func New

func New(config Config) gin.HandlerFunc

Types

type Config

type Config struct {
	AbortOnError    bool
	AllowAllOrigins bool

	// AllowedOrigins is a list of origins a cross-domain request can be executed from.
	// If the special "*" value is present in the list, all origins will be allowed.
	// Default value is ["*"]
	AllowedOrigins []string

	// AllowOriginFunc is a custom function to validate the origin. It take the origin
	// as argument and returns true if allowed or false otherwise. If this option is
	// set, the content of AllowedOrigins is ignored.
	AllowOriginFunc func(origin string) bool

	// AllowedMethods is a list of methods the client is allowed to use with
	// cross-domain requests. Default value is simple methods (GET and POST)
	AllowedMethods []string

	// AllowedHeaders is list of non simple headers the client is allowed to use with
	// cross-domain requests.
	// If the special "*" value is present in the list, all headers will be allowed.
	// Default value is [] but "Origin" is always appended to the list.
	AllowedHeaders []string

	// ExposedHeaders indicates which headers are safe to expose to the API of a CORS
	// API specification
	ExposedHeaders []string

	// AllowCredentials indicates whether the request can include user credentials like
	// cookies, HTTP authentication or client side SSL certificates.
	AllowCredentials bool

	// MaxAge indicates how long (in seconds) the results of a preflight request
	// can be cached
	MaxAge time.Duration
}

func DefaultConfig

func DefaultConfig() Config

func (*Config) AddAllowedHeaders

func (c *Config) AddAllowedHeaders(headers ...string)

func (*Config) AddAllowedMethods

func (c *Config) AddAllowedMethods(methods ...string)

func (*Config) AddExposedHeaders

func (c *Config) AddExposedHeaders(headers ...string)

func (Config) Validate

func (c Config) Validate() error