routes

Documentation

Index

• type Route
• type Router
  • func NewRouter(r *mux.Router) Router
  • func (r *Router) AddRoute(route Route)
  • func (r *Router) GetRouteByName(name string) Route
  • func (r *Router) Prepare() *mux.Router
  • func (r *Router) RouteUrl(name string) string

Types

type Route

type Route struct {
	Name    string
	Path    string
	Method  string
	Handler http.HandlerFunc
}

route structure

type Router

type Router struct {
	Mux *mux.Router

	Routes []Route
}

Router structure is a url handler

func NewRouter

func NewRouter(r *mux.Router) Router

NewRouter basically creates router

func (*Router) AddRoute

func (r *Router) AddRoute(route Route)

AddRoute will append your route to Endpoints

func (*Router) GetRouteByName

func (r *Router) GetRouteByName(name string) Route

func (*Router) Prepare

func (r *Router) Prepare() *mux.Router

Prepare parses Endpoints property and returns mux with applied routes

func (*Router) RouteUrl

func (r *Router) RouteUrl(name string) string