add_header

README

Header Adding Middleware

The header adding middleware is used to add custom headers to responses.

Example

The header adding should be configured with actual headers to add. It will work as a NoOp, if none are provided.

finalHandler := midgard.StackMiddlewareHandler(
    []midgard.Middleware{
        add_header.New(
            add_header.WithHeaders(map[string]string{
                "X-Test": "TestHeaderValue",
            }),
        ),
    },
    http.HandlerFunc(HelloHandler),
)

Documentation

Index

• func New(options ...func(*Handler) error) (defs.Middleware, error)
• func WithHeaders(headers map[string]string) func(*Handler) error
• func WithLogLevel(level slog.Level) func(h *Handler) error
• func WithLogger(log *slog.Logger) func(h *Handler) error
• type Handler
  • func (h *Handler) GetMWBase() *defs.MWBase
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Functions

func New

func New(options ...func(*Handler) error) (defs.Middleware, error)

New generates a new header adding middleware.

func WithHeaders

func WithHeaders(headers map[string]string) func(*Handler) error

WithHeaders configures the headers to add to responses.

func WithLogLevel

func WithLogLevel(level slog.Level) func(h *Handler) error

WithLogLevel configures the log level to use with the logger.

func WithLogger

func WithLogger(log *slog.Logger) func(h *Handler) error

WithLogger configures the logger to use.

Types

type Handler

type Handler struct {
	defs.MWBase
	// contains filtered or unexported fields
}

Handler holds the information of the added headers

func (*Handler) GetMWBase

func (h *Handler) GetMWBase() *defs.MWBase

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP handles the requests, adding the additionally provided headers to the responses.