api

Documentation

Index

• func WrappedHandleFunc(fun func(w http.ResponseWriter, r *http.Request)) func(http.ResponseWriter, *http.Request, httprouter.Params)
• type API
  • func New(port int, options ...Option) *API
  • func (api *API) Join()
  • func (api *API) Start()
  • func (api *API) Stop() error
  • func (api *API) String() string
• type Option
  • func WithLogger(logger zerolog.Logger) Option

Functions

func WrappedHandleFunc

func WrappedHandleFunc(fun func(w http.ResponseWriter, r *http.Request)) func(http.ResponseWriter, *http.Request, httprouter.Params)

WrappedHandleFunc wraps the usual http handler function into a function as expected by httprouter

Types

type API

type API struct {
	Router *httprouter.Router
	// contains filtered or unexported fields
}

API represents the implementation of the HTTP api of sokar

func New

func New(port int, options ...Option) *API

New creates a new runnable api server

func (*API) Join

func (api *API) Join()

Join waits until the api server has been teared down

func (*API) Start

func (api *API) Start()

Start the api server for sokar

func (*API) Stop

func (api *API) Stop() error

Stop stops/ tears down the api server

func (*API) String

func (api *API) String() string

String returns the name of this component

type Option

type Option func(api *API)

Option represents an option for the api

func WithLogger

func WithLogger(logger zerolog.Logger) Option

WithLogger adds a configured Logger to the api