apikey

Documentation

Index

• func New(name string, location string, paramName string, value string, ...) contract.Security
• type Cookie
  • func (sec Cookie) Enrich(req *http.Request, log contract.Logger)
• type Header
  • func (sec Header) Enrich(req *http.Request, log contract.Logger)
• type Query
  • func (sec Query) Enrich(req *http.Request, log contract.Logger)
• type Security
  • func (sec Security) GetName() string

Functions

func New

func New(name string, location string, paramName string, value string, logger contract.Logger) contract.Security

New creates a new API Key security scheme.

Types

type Cookie

type Cookie struct {
	Security
}

Cookie represents an API token security which expects a token as a header value.

func (Cookie) Enrich

func (sec Cookie) Enrich(req *http.Request, log contract.Logger)

Enrich adds an API key to the request's headers.

type Header

type Header struct {
	Security
}

Header represents an API token security which expects a token as a header value.

func (Header) Enrich

func (sec Header) Enrich(req *http.Request, log contract.Logger)

Enrich adds an API key to the request's headers.

type Query

type Query struct {
	Security
}

Query represents an API token security which expects a token as a query parameter.

func (Query) Enrich

func (sec Query) Enrich(req *http.Request, log contract.Logger)

Enrich adds an API key to the request's query.

type Security

type Security struct {
	Name      string
	ParamName string
	Value     string
	Log       contract.Logger
}

Security implements the security type that requires a unique API key to be present in each API request. The exact location of the key is implemented corresponding classes.

func (Security) GetName

func (sec Security) GetName() string

GetName returns name.