route

Documentation

Index

• Variables
• type Collection
• type Group
  • func NewGroup(groupNamers ...func(string) string) *Group
  • func (g *Group) AddNamer(namers ...func(string) string)
  • func (g *Group) Apply(e echo.RouteRegister, rootGroup string)
  • func (g *Group) Pre(groupName string, middlewares ...interface{})
  • func (g *Group) Register(groupName string, fn func(echo.RouteRegister), middlewares ...interface{})
  • func (g *Group) SetMeta(groupName string, meta echo.H)
  • func (g *Group) SetMetaKV(groupName string, key string, val interface{})
  • func (g *Group) SetNamer(namers ...func(string) string)
  • func (g *Group) Use(groupName string, middlewares ...interface{})
• type Host
  • func (h *Host) Register(groupName string, fn func(echo.RouteRegister), middlewares ...interface{})
  • func (h *Host) SetAlias(alias string) *Host
  • func (h *Host) Use(middlewares ...interface{})
• type IRegister
  • func NewRegister(e *echo.Echo, groupNamers ...func(string) string) IRegister
• type MetaSetter
• type Register
  • func (r *Register) AddGroupNamer(namers ...func(string) string)
  • func (r *Register) Apply()
  • func (r *Register) Echo() *echo.Echo
  • func (r *Register) HandlerWithRequest(handler interface{}, requests interface{}, methods ...string) echo.Handler
  • func (r *Register) Host(hostName string, middlewares ...interface{}) *Host
  • func (r *Register) Logger() logger.Logger
  • func (r *Register) MetaHandler(m echo.H, handler interface{}, requests ...interface{}) echo.Handler
  • func (r *Register) MetaHandlerWithRequest(m echo.H, handler interface{}, requests interface{}, methods ...string) echo.Handler
  • func (r *Register) Pre(middlewares ...interface{})
  • func (r *Register) PreToGroup(groupName string, middlewares ...interface{})
  • func (r *Register) Prefix() string
  • func (r *Register) Register(fn func(echo.RouteRegister))
  • func (r *Register) RegisterToGroup(groupName string, fn func(echo.RouteRegister), middlewares ...interface{}) MetaSetter
  • func (r *Register) RootGroup() string
  • func (r *Register) Routes() []*echo.Route
  • func (r *Register) SetGroupNamer(namers ...func(string) string)
  • func (r *Register) SetPrefix(prefix string)
  • func (r *Register) SetRootGroup(groupName string)
  • func (r *Register) Use(middlewares ...interface{})
  • func (r *Register) UseToGroup(groupName string, middlewares ...interface{})
• type Registers
  • func (r Registers) Apply(g echo.RouteRegister)
  • func (r *Registers) Register(rg ...func(g echo.RouteRegister))

Variables

var Default = &Collection{}

Types

type Collection

type Collection struct {
	Backend  IRegister
	Frontend IRegister
}

type Group

type Group struct {
	Handlers       map[string][]func(echo.RouteRegister)
	Namers         []func(string) string
	Middlewares    map[string][]interface{}
	PreMiddlewares map[string][]interface{}
	Metas          map[string]echo.H
}

func NewGroup

func NewGroup(groupNamers ...func(string) string) *Group

func (*Group) AddNamer

func (g *Group) AddNamer(namers ...func(string) string)

func (*Group) Apply

func (g *Group) Apply(e echo.RouteRegister, rootGroup string)

func (*Group) Pre

func (g *Group) Pre(groupName string, middlewares ...interface{})

func (*Group) Register

func (g *Group) Register(groupName string, fn func(echo.RouteRegister), middlewares ...interface{})

func (*Group) SetMeta

func (g *Group) SetMeta(groupName string, meta echo.H)

func (*Group) SetMetaKV

func (g *Group) SetMetaKV(groupName string, key string, val interface{})

func (*Group) SetNamer

func (g *Group) SetNamer(namers ...func(string) string)

func (*Group) Use

func (g *Group) Use(groupName string, middlewares ...interface{})

type Host

type Host struct {
	Name        string
	Alias       string
	Middlewares []interface{}
	Group       *Group
}

func (*Host) Register

func (h *Host) Register(groupName string, fn func(echo.RouteRegister), middlewares ...interface{})

func (*Host) SetAlias

func (h *Host) SetAlias(alias string) *Host

func (*Host) Use

func (h *Host) Use(middlewares ...interface{})

type IRegister

type IRegister interface {
	Echo() *echo.Echo
	Routes() []*echo.Route
	Logger() logger.Logger
	Prefix() string
	SetPrefix(prefix string)
	MetaHandler(m echo.H, handler interface{}, requests ...interface{}) echo.Handler
	MetaHandlerWithRequest(m echo.H, handler interface{}, request interface{}, methods ...string) echo.Handler
	HandlerWithRequest(handler interface{}, requests interface{}, methods ...string) echo.Handler
	AddGroupNamer(namers ...func(string) string)
	SetGroupNamer(namers ...func(string) string)
	SetRootGroup(groupName string)
	RootGroup() string
	Apply()
	Pre(middlewares ...interface{})
	Use(middlewares ...interface{})
	PreToGroup(groupName string, middlewares ...interface{})
	UseToGroup(groupName string, middlewares ...interface{})
	Register(fn func(echo.RouteRegister))
	RegisterToGroup(groupName string, fn func(echo.RouteRegister), middlewares ...interface{}) MetaSetter
	Host(hostName string, middlewares ...interface{}) *Host
}

func NewRegister

func NewRegister(e *echo.Echo, groupNamers ...func(string) string) IRegister

type MetaSetter

type MetaSetter interface {
	SetMeta(meta echo.H) MetaSetter
	SetMetaKV(key string, val interface{}) MetaSetter
}

type Register

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

func (*Register) AddGroupNamer

func (r *Register) AddGroupNamer(namers ...func(string) string)

func (*Register) Apply

func (r *Register) Apply()

func (*Register) Echo

func (r *Register) Echo() *echo.Echo

func (*Register) HandlerWithRequest

func (r *Register) HandlerWithRequest(handler interface{}, requests interface{}, methods ...string) echo.Handler

func (*Register) Host

func (r *Register) Host(hostName string, middlewares ...interface{}) *Host

func (*Register) Logger

func (r *Register) Logger() logger.Logger

func (*Register) MetaHandler

func (r *Register) MetaHandler(m echo.H, handler interface{}, requests ...interface{}) echo.Handler

func (*Register) MetaHandlerWithRequest

func (r *Register) MetaHandlerWithRequest(m echo.H, handler interface{}, requests interface{}, methods ...string) echo.Handler

func (*Register) Pre

func (r *Register) Pre(middlewares ...interface{})

func (*Register) PreToGroup

func (r *Register) PreToGroup(groupName string, middlewares ...interface{})

func (*Register) Prefix

func (r *Register) Prefix() string

func (*Register) Register

func (r *Register) Register(fn func(echo.RouteRegister))

func (*Register) RegisterToGroup

func (r *Register) RegisterToGroup(groupName string, fn func(echo.RouteRegister), middlewares ...interface{}) MetaSetter

func (*Register) RootGroup

func (r *Register) RootGroup() string

func (*Register) Routes

func (r *Register) Routes() []*echo.Route

func (*Register) SetGroupNamer

func (r *Register) SetGroupNamer(namers ...func(string) string)

func (*Register) SetPrefix

func (r *Register) SetPrefix(prefix string)

func (*Register) SetRootGroup

func (r *Register) SetRootGroup(groupName string)

func (*Register) Use

func (r *Register) Use(middlewares ...interface{})

func (*Register) UseToGroup

func (r *Register) UseToGroup(groupName string, middlewares ...interface{})

type Registers

type Registers []func(g echo.RouteRegister)

func (Registers) Apply

func (r Registers) Apply(g echo.RouteRegister)

func (*Registers) Register

func (r *Registers) Register(rg ...func(g echo.RouteRegister))