api

Documentation

Overview

Package api package

Index

• type RouteBuilder
  • func NewRouteBuilder(middlewares ...func(http.Handler) http.Handler) *RouteBuilder
  • func (rb *RouteBuilder) AddHandler(pattern string, handler http.Handler, ...) *RouteBuilder
  • func (rb *RouteBuilder) AddHandlerFunc(method string, pattern string, handler http.HandlerFunc) *RouteBuilder
  • func (rb *RouteBuilder) AddRoutes(controller controllers.Controller) *RouteBuilder
  • func (rb *RouteBuilder) Router() chi.Router
  • func (rb *RouteBuilder) SubRouteBuilder(subPath string) *RouteBuilder
  • func (rb *RouteBuilder) WithSubRouter(subPath string, middlewares ...func(http.Handler) http.Handler) *RouteBuilder

Types

type RouteBuilder

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

RouteBuilder is used to build a Router instance

func NewRouteBuilder

func NewRouteBuilder(middlewares ...func(http.Handler) http.Handler) *RouteBuilder

NewRouteBuilder creates an instance of RouterBuilder

func (*RouteBuilder) AddHandler

func (rb *RouteBuilder) AddHandler(pattern string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) *RouteBuilder

AddHandler adds the handler to the path

func (*RouteBuilder) AddHandlerFunc

func (rb *RouteBuilder) AddHandlerFunc(method string, pattern string, handler http.HandlerFunc) *RouteBuilder

AddHandlerFunc adds a handler function to the router for a specific pattern

func (*RouteBuilder) AddRoutes

func (rb *RouteBuilder) AddRoutes(controller controllers.Controller) *RouteBuilder

AddRoutes adds the controllers routes to the path

func (*RouteBuilder) Router

func (rb *RouteBuilder) Router() chi.Router

Router returns and instance of a chi.Router with all routes added

func (*RouteBuilder) SubRouteBuilder

func (rb *RouteBuilder) SubRouteBuilder(subPath string) *RouteBuilder

SubRouteBuilder returns a RouteBuilder under the given subpath

func (*RouteBuilder) WithSubRouter

func (rb *RouteBuilder) WithSubRouter(subPath string, middlewares ...func(http.Handler) http.Handler) *RouteBuilder

WithSubRouter mounts a router under the current RouteBuilder with the given subpath