headers

Documentation

Index

• Constants
• type CORSConfig
• type Config
• type Plugin
  • func (s *Plugin) Init(cfg config.Configurer) error
  • func (s *Plugin) Middleware(next http.Handler) http.HandlerFunc
  • func (s *Plugin) Name() string

Constants

const PluginName = "headers"

ID contains default service name.

const RootPluginName = "http"

Types

type CORSConfig

type CORSConfig struct {
	// AllowedOrigin: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
	AllowedOrigin string `mapstructure:"allowed_origin"`

	// AllowedHeaders: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers
	AllowedHeaders string `mapstructure:"allowed_headers"`

	// AllowedMethods: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
	AllowedMethods string `mapstructure:"allowed_methods"`

	// AllowCredentials https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials
	AllowCredentials *bool `mapstructure:"allow_credentials"`

	// ExposeHeaders:  https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers
	ExposedHeaders string `mapstructure:"exposed_headers"`

	// MaxAge of CORS headers in seconds/
	MaxAge int `mapstructure:"max_age"`
}

CORSConfig headers configuration.

type Config

type Config struct {
	Headers *struct {
		// CORS settings.
		CORS *CORSConfig

		// Request headers to add to every payload send to PHP.
		Request map[string]string

		// Response headers to add to every payload generated by PHP.
		Response map[string]string
	}
}

Config declares headers service configuration.

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Service serves headers files. Potentially convert into middleware?

func (*Plugin) Init

func (s *Plugin) Init(cfg config.Configurer) error

Init must return configure service and return true if service hasStatus enabled. Must return error in case of misconfiguration. Services must not be used without proper configuration pushed first.

func (*Plugin) Middleware

func (s *Plugin) Middleware(next http.Handler) http.HandlerFunc

middleware must return true if request/response pair is handled within the middleware.

func (*Plugin) Name

func (s *Plugin) Name() string