router

Documentation

Index

• type Router
  • func NewRouter() *Router
  • func (r *Router) SetAllowCors() *Router
  • func (r *Router) SetGzip() *Router
  • func (r *Router) SetLevelDBCache(expires ...time.Duration) *Router
  • func (r *Router) SetRateLimiter(opt ...int) *Router
  • func (r *Router) SetRoutes() *Router

Types

type Router

type Router struct {
	Engine   *gin.Engine
	Cached   *gin.RouterGroup
	Uncached *gin.RouterGroup
}

Router contains bindings for gin's router engine

func NewRouter

func NewRouter() *Router

NewRouter returns nikel-core's base router

func (*Router) SetAllowCors

func (r *Router) SetAllowCors() *Router

SetAllowCors allows all origins

func (*Router) SetGzip

func (r *Router) SetGzip() *Router

SetGzip gzips all api responses

func (*Router) SetLevelDBCache

func (r *Router) SetLevelDBCache(expires ...time.Duration) *Router

SetLevelDBCache sets a LevelDB backed cache

func (*Router) SetRateLimiter

func (r *Router) SetRateLimiter(opt ...int) *Router

SetRateLimiter sets the rate limiter

func (*Router) SetRoutes

func (r *Router) SetRoutes() *Router

SetRoutes sets the routes