routing

Documentation

Index

• Variables
• func PresentError(logger logr.Logger, w http.ResponseWriter, err error)
• type Handler
  • func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Response
  • func NewResponse(httpStatus int) *Response
  • func (r *Response) WithBody(body interface{}) *Response
  • func (r *Response) WithHeader(key, value string) *Response
• type Routable
• type Route
• type RouterBuilder
  • func NewRouterBuilder() *RouterBuilder
  • func (b *RouterBuilder) Build() *chi.Mux
  • func (b *RouterBuilder) LoadRoutes(routable Routable)
  • func (b *RouterBuilder) SetMethodNotAllowedHandler(handler Handler)
  • func (b *RouterBuilder) SetNotFoundHandler(handler Handler)
  • func (b *RouterBuilder) UseAuthMiddleware(middleware ...func(http.Handler) http.Handler)
  • func (b *RouterBuilder) UseMiddleware(middleware ...func(http.Handler) http.Handler)

Variables

var URLParam = chi.URLParam

Functions

func PresentError

func PresentError(logger logr.Logger, w http.ResponseWriter, err error)

Types

type Handler

type Handler func(r *http.Request) (*Response, error)

func (Handler) ServeHTTP

func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Response

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

func NewResponse

func NewResponse(httpStatus int) *Response

func (*Response) WithBody

func (r *Response) WithBody(body interface{}) *Response

func (*Response) WithHeader

func (r *Response) WithHeader(key, value string) *Response

type Routable

type Routable interface {
	AuthenticatedRoutes() []Route
	UnauthenticatedRoutes() []Route
}

type Route

type Route struct {
	Method  string
	Pattern string
	Handler Handler
}

type RouterBuilder

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

func NewRouterBuilder

func NewRouterBuilder() *RouterBuilder

func (*RouterBuilder) Build

func (b *RouterBuilder) Build() *chi.Mux

func (*RouterBuilder) LoadRoutes

func (b *RouterBuilder) LoadRoutes(routable Routable)

func (*RouterBuilder) SetMethodNotAllowedHandler

func (b *RouterBuilder) SetMethodNotAllowedHandler(handler Handler)

func (*RouterBuilder) SetNotFoundHandler

func (b *RouterBuilder) SetNotFoundHandler(handler Handler)

func (*RouterBuilder) UseAuthMiddleware

func (b *RouterBuilder) UseAuthMiddleware(middleware ...func(http.Handler) http.Handler)

func (*RouterBuilder) UseMiddleware

func (b *RouterBuilder) UseMiddleware(middleware ...func(http.Handler) http.Handler)