api

Documentation

Index

• type API
  • func New(token string) *API
  • func (api *API) RegisterFunc(path string, fn http.HandlerFunc)
  • func (api *API) RegisterHandler(path string, handler http.Handler)
  • func (api *API) RequireToken(fn http.HandlerFunc) http.HandlerFunc
  • func (api *API) Start(block bool) error

Types

type API

type API struct {
	Token string
	// contains filtered or unexported fields
}

API is the http server responsible for serving the HTTP API endpoints

func New

func New(token string) *API

New is a factory function creating a new API instance

func (*API) RegisterFunc

func (api *API) RegisterFunc(path string, fn http.HandlerFunc)

RegisterFunc is a wrapper around http.HandleFunc that also sets the flag used to determine whether to launch the API

func (*API) RegisterHandler

func (api *API) RegisterHandler(path string, handler http.Handler)

RegisterHandler is a wrapper around http.Handler that also sets the flag used to determine whether to launch the API

func (*API) RequireToken

func (api *API) RequireToken(fn http.HandlerFunc) http.HandlerFunc

RequireToken is wrapper around http.HandleFunc that checks token validity

func (*API) Start

func (api *API) Start(block bool) error

Start the API and serve over HTTP. Requires an API Token to be set.