headers

Documentation

Overview

Package headers provides middleware that appends headers to requests based on a set of configuration rules that define which routes receive which headers.

Index

• func New(c middleware.Controller) (middleware.Middleware, error)
• type Header
• type HeaderRule
• type Headers
  • func (h Headers) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

Functions

func New

func New(c middleware.Controller) (middleware.Middleware, error)

New constructs and configures a new headers middleware instance.

Types

type Header

type Header struct {
	Name  string
	Value string
}

Header represents a single HTTP header, simply a name and value.

type HeaderRule

type HeaderRule struct {
	Url     string
	Headers []Header
}

HeaderRule groups a slice of HTTP headers by a URL pattern. TODO: use http.Header type instead?

type Headers

type Headers struct {
	Next  middleware.Handler
	Rules []HeaderRule
}

Headers is middleware that adds headers to the responses for requests matching a certain path.

func (Headers) ServeHTTP

func (h Headers) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

ServeHTTP implements the middleware.Handler interface and serves requests, adding headers to the response according to the configured rules.