Documentation
¶
Index ¶
- Variables
- func ChainHandlers(lastHandler http.Handler, handlers ...func(http.Handler) http.Handler) http.Handler
- func SplitPattern(pattern string) (string, string, error)
- type Logger
- type Router
- func (r *Router) ExactHandleFunc(pattern string, handler http.HandlerFunc, ...)
- func (r *Router) FullPath() string
- func (r *Router) GetMiddlewares() *[]func(http.Handler) http.Handler
- func (r *Router) HandleFunc(pattern string, handler http.HandlerFunc, ...)
- func (r *Router) Handler() http.Handler
- func (r *Router) Logger() *Logger
- func (r *Router) Method() string
- func (r *Router) Mode() *goflagsmode.Flag
- func (r *Router) Mux() *http.ServeMux
- func (r *Router) NewGroup(pattern string, middlewares ...func(next http.Handler) http.Handler) RouterWrapper
- func (r *Router) Pattern() string
- func (r *Router) RegisterExactRoute(pattern string, handler http.HandlerFunc, ...)
- func (r *Router) RegisterGroup(router RouterWrapper)
- func (r *Router) RegisterHandler(pattern string, handler http.Handler)
- func (r *Router) RegisterRoute(pattern string, handler http.HandlerFunc, ...)
- func (r *Router) RelativePath() string
- func (r *Router) ServeStaticFiles(pattern, path string)
- type RouterWrapper
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrNilRouter = errors.New("router cannot be nil") ErrNilMiddleware = "%s: middleware at index %d cannot be nil" ErrEmptyPattern = errors.New("pattern cannot be empty") )
Functions ¶
Types ¶
type Logger ¶ added in v0.4.0
type Logger struct {
// contains filtered or unexported fields
}
Logger is the logger for router
func NewLogger ¶ added in v0.4.0
func NewLogger(header string, modeLogger gologgermode.Logger) (*Logger, error)
NewLogger is the logger for the router
func (*Logger) RegisterRoute ¶ added in v0.4.0
RegisterRoute registers a route
func (*Logger) RegisterRouteGroup ¶ added in v0.4.0
RegisterRouteGroup registers a route group
type Router ¶ added in v0.2.2
type Router struct {
// contains filtered or unexported fields
}
Router is the route group struct
func (*Router) ExactHandleFunc ¶ added in v0.7.24
func (r *Router) ExactHandleFunc( pattern string, handler http.HandlerFunc, middlewares ...func(http.Handler) http.Handler, )
ExactHandleFunc registers a new route with a path, the handler function and the middlewares
func (*Router) GetMiddlewares ¶ added in v0.7.10
GetMiddlewares returns the middlewares
func (*Router) HandleFunc ¶ added in v0.2.2
func (r *Router) HandleFunc( pattern string, handler http.HandlerFunc, middlewares ...func(http.Handler) http.Handler, )
HandleFunc registers a new route with a path, the handler function and the middlewares
func (*Router) Mode ¶ added in v0.9.15
func (r *Router) Mode() *goflagsmode.Flag
Mode returns the mode
func (*Router) NewGroup ¶ added in v0.4.2
func (r *Router) NewGroup( pattern string, middlewares ...func(next http.Handler) http.Handler, ) RouterWrapper
NewGroup creates a new router group with a path
func (*Router) RegisterExactRoute ¶ added in v0.7.24
func (r *Router) RegisterExactRoute( pattern string, handler http.HandlerFunc, middlewares ...func(http.Handler) http.Handler, )
RegisterExactRoute registers a new route with a path, the handler function and the middlewares. This matches the exact path
func (*Router) RegisterGroup ¶ added in v0.4.2
func (r *Router) RegisterGroup(router RouterWrapper)
RegisterGroup registers a new router group with a path and a router
func (*Router) RegisterHandler ¶ added in v0.2.2
RegisterHandler registers a new route group with a path and a handler function
func (*Router) RegisterRoute ¶ added in v0.2.2
func (r *Router) RegisterRoute( pattern string, handler http.HandlerFunc, middlewares ...func(http.Handler) http.Handler, )
RegisterRoute registers a new route with a path, the handler function and the middlewares. This does not match the exact path
func (*Router) RelativePath ¶ added in v0.7.22
RelativePath returns the relative path
func (*Router) ServeStaticFiles ¶ added in v0.9.11
ServeStaticFiles serves the static files
type RouterWrapper ¶ added in v0.2.2
type RouterWrapper interface {
Handler() http.Handler
Mux() *http.ServeMux
GetMiddlewares() *[]func(http.Handler) http.Handler
HandleFunc(
pattern string,
handler http.HandlerFunc,
middlewares ...func(next http.Handler) http.Handler,
)
ExactHandleFunc(
pattern string,
handler http.HandlerFunc,
middlewares ...func(next http.Handler) http.Handler,
)
RegisterRoute(
pattern string,
handler http.HandlerFunc,
middlewares ...func(next http.Handler) http.Handler,
)
RegisterExactRoute(
pattern string,
handler http.HandlerFunc,
middlewares ...func(next http.Handler) http.Handler,
)
RegisterHandler(pattern string, handler http.Handler)
NewGroup(
pattern string,
middlewares ...func(next http.Handler) http.Handler,
) RouterWrapper
RegisterGroup(router RouterWrapper)
Pattern() string
RelativePath() string
FullPath() string
Method() string
ServeStaticFiles(pattern, path string)
Logger() *Logger
Mode() *goflagsmode.Flag
}
RouterWrapper is the interface for the routes
func NewBaseRouter ¶ added in v0.4.2
func NewBaseRouter( mode *goflagsmode.Flag, logger *Logger, middlewares ...func(next http.Handler) http.Handler, ) (RouterWrapper, error)
NewBaseRouter creates a new base router
func NewGroup ¶
func NewGroup( baseRouter RouterWrapper, pattern string, middlewares ...func(next http.Handler) http.Handler, ) (RouterWrapper, error)
NewGroup creates a new router group
Source Files
Click to show internal directories.
Click to hide internal directories.