handler

Documentation

Index

• type Auth
• type HTTPHandler
  • func NewHTTPHandler(path, method string, handle http.HandlerFunc, opts ...HTTPHandlerOpts) *HTTPHandler
  • func (h *HTTPHandler) Auth() Auth
  • func (h *HTTPHandler) Handle() http.HandlerFunc
  • func (h *HTTPHandler) Method() string
  • func (h *HTTPHandler) Path() string
• type HTTPHandlerOpts
  • func WithAuth(auth Auth) HTTPHandlerOpts
• type Handler

Types

type Auth

type Auth int

Auth handler auth type.

const (
	// AuthNone no auth.
	AuthNone Auth = iota
	// AuthHTTPSig http sig auth.
	AuthHTTPSig
	// AuthToken static token.
	AuthToken
)

type HTTPHandler

type HTTPHandler struct {
	// contains filtered or unexported fields
}

HTTPHandler contains REST API handling details which can be used to build routers for http requests for given path.

func NewHTTPHandler

func NewHTTPHandler(path, method string, handle http.HandlerFunc, opts ...HTTPHandlerOpts) *HTTPHandler

NewHTTPHandler returns instance of HTTPHandler which can be used to handle http requests.

func (*HTTPHandler) Auth

func (h *HTTPHandler) Auth() Auth

Auth returns http request auth type.

func (*HTTPHandler) Handle

func (h *HTTPHandler) Handle() http.HandlerFunc

Handle returns http request handle func.

func (*HTTPHandler) Method

func (h *HTTPHandler) Method() string

Method returns http request method type.

func (*HTTPHandler) Path

func (h *HTTPHandler) Path() string

Path returns http request path.

type HTTPHandlerOpts

type HTTPHandlerOpts func(opts *httpHandlerOpts)

HTTPHandlerOpts are the http handler additional options.

func WithAuth

func WithAuth(auth Auth) HTTPHandlerOpts

WithAuth option enable auth for http handler.

type Handler

type Handler interface {
	Path() string
	Method() string
	Handle() http.HandlerFunc
	Auth() Auth
}

Handler http handler for each controller API endpoint.