router

Documentation

Index

• type GroupInterface
  • func NewGroup() GroupInterface
• type Handler
• type Middleware
• type RouteInterface
  • func NewRoute() RouteInterface
• type RouterInterface
  • func NewRouter() RouterInterface

Types

type GroupInterface

type GroupInterface interface {
	GetPrefix() string
	SetPrefix(prefix string) GroupInterface

	AddRoute(route RouteInterface) GroupInterface
	AddRoutes(routes []RouteInterface) GroupInterface
	GetRoutes() []RouteInterface

	AddGroup(group GroupInterface) GroupInterface
	AddGroups(groups []GroupInterface) GroupInterface
	GetGroups() []GroupInterface

	AddBeforeMiddlewares(middleware []Middleware) GroupInterface
	GetBeforeMiddlewares() []Middleware

	AddAfterMiddlewares(middleware []Middleware) GroupInterface
	GetAfterMiddlewares() []Middleware
}

Group represents a group of routes.

func NewGroup

func NewGroup() GroupInterface

type Handler

type Handler func(http.ResponseWriter, *http.Request)

Handler represents the function that handles a request.

type Middleware

type Middleware func(http.Handler) http.Handler

Middleware represents a middleware function.

type RouteInterface

type RouteInterface interface {
	GetMethod() string
	SetMethod(method string) RouteInterface

	GetPath() string
	SetPath(path string) RouteInterface

	GetHandler() Handler
	SetHandler(handler Handler) RouteInterface

	GetName() string
	SetName(name string) RouteInterface

	AddBeforeMiddlewares(middleware []Middleware) RouteInterface
	GetBeforeMiddlewares() []Middleware

	AddAfterMiddlewares(middleware []Middleware) RouteInterface
	GetAfterMiddlewares() []Middleware
}

Route represents a single route definition.

func NewRoute

func NewRoute() RouteInterface

type RouterInterface

type RouterInterface interface {
	GetPrefix() string
	SetPrefix(prefix string) RouterInterface

	AddGroup(group GroupInterface) RouterInterface
	AddGroups(groups []GroupInterface) RouterInterface
	GetGroups() []GroupInterface

	AddRoute(route RouteInterface) RouterInterface
	AddRoutes(routes []RouteInterface) RouterInterface
	GetRoutes() []RouteInterface

	AddBeforeMiddlewares(middleware []Middleware) RouterInterface
	GetBeforeMiddlewares() []Middleware

	AddAfterMiddlewares(middleware []Middleware) RouterInterface
	GetAfterMiddlewares() []Middleware

	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

Router represents a router that can handle requests.

func NewRouter

func NewRouter() RouterInterface