route

package
v0.7.12 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 31, 2025 License: GPL-3.0 Imports: 5 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrNilRouter = errors.New("router cannot be nil")
)

Functions

func ChainHandlers added in v0.5.10

func ChainHandlers(
	lastHandler http.Handler,
	handlers ...func(http.Handler) http.Handler,
) http.Handler

ChainHandlers chains the handlers

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

func (l *Logger) RegisterRoute(routerPath string, routePath string)

RegisterRoute registers a route

func (*Logger) RegisterRouteGroup added in v0.4.0

func (l *Logger) RegisterRouteGroup(routerPath string, routerGroupPath string)

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 NewBaseRouter added in v0.4.2

func NewBaseRouter(
	mode *goflagsmode.Flag,
	logger *Logger,
	middlewares ...func(next http.Handler) http.Handler,
) *Router

NewBaseRouter creates a new base router

func NewGroup

func NewGroup(
	baseRouter *Router,
	path string,
	middlewares ...func(next http.Handler) http.Handler,
) (*Router, error)

NewGroup creates a new router group

func NewRouter added in v0.2.2

func NewRouter(
	path string,
	mode *goflagsmode.Flag,
	logger *Logger,
	middlewares ...func(next http.Handler) http.Handler,
) *Router

NewRouter creates a new router

func (*Router) GetMiddlewares added in v0.7.10

func (r *Router) GetMiddlewares() *[]func(http.Handler) http.Handler

GetMiddlewares returns the middlewares

func (*Router) HandleFunc added in v0.2.2

func (r *Router) HandleFunc(
	path 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) Handler added in v0.2.3

func (r *Router) Handler() http.Handler

Handler returns the first handler

func (*Router) Mux added in v0.5.10

func (r *Router) Mux() *http.ServeMux

Mux returns the multiplexer

func (*Router) NewGroup added in v0.4.2

func (r *Router) NewGroup(
	path string,
	middlewares ...func(next http.Handler) http.Handler,
) *Router

NewGroup creates a new router group with a path

func (*Router) RegisterGroup added in v0.4.2

func (r *Router) RegisterGroup(path string, router *Router)

RegisterGroup registers a new router group with a path and a router

func (*Router) RegisterHandler added in v0.2.2

func (r *Router) RegisterHandler(path string, handler http.Handler)

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(
	path string,
	handler http.HandlerFunc,
	middlewares ...func(http.Handler) http.Handler,
)

RegisterRoute registers a new route with a path, the handler function and the middlewares

type RouterWrapper added in v0.2.2

type RouterWrapper interface {
	Handler() http.Handler
	Mux() *http.ServeMux
	GetMiddlewares() *[]func(http.Handler) http.Handler
	HandleFunc(
		path string,
		handler http.HandlerFunc,
		middlewares ...func(next http.Handler) http.Handler,
	)
	RegisterRoute(
		path string,
		handler http.HandlerFunc,
		middlewares ...func(next http.Handler) http.Handler,
	)
	RegisterHandler(path string, handler http.Handler)
	NewGroup(
		path string,
		middlewares ...func(next http.Handler) http.Handler,
	) *Router
	RegisterGroup(path string, router *Router)
}

RouterWrapper is the interface for the routes

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL