apikey

Documentation

Index

• Variables
• func New(config Config) fiber.Handler
• type Config

Variables

var ConfigDefault = Config{
	Next:         nil,
	Authorizer:   nil,
	Unauthorized: nil,
	ContextToken: "token",
}

ConfigDefault is the default config

Functions

func New

func New(config Config) fiber.Handler

New creates a new middleware handler

Types

type Config

type Config struct {
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c *fiber.Ctx) bool

	// Authorizer defines a function you can pass
	// to check the credentials however you want.
	// It will be called with a token
	// and is expected to return true or false to indicate
	// that the credentials were approved or not.
	//
	// Optional. Default: nil.
	Authorizer func(string) bool

	// Unauthorized defines the response body for unauthorized responses.
	// By default it will return with a 401 Unauthorized and the correct WWW-Auth header
	//
	// Optional. Default: nil
	Unauthorized fiber.Handler

	// ContextToken is the key to store the token in Locals
	//
	// Optional. Default: "token"
	ContextToken string
}

Config defines the config for middleware.