router

Documentation

Overview

Package router implements a router of the http handler.

Index

• Variables
• type Router
  • func NewDefaultRouter(router http.Handler) *Router
  • func NewRouter(router http.Handler) *Router
  • func (r *Router) ServeHTTP(resp http.ResponseWriter, req *http.Request)
  • func (r *Router) Use(ms ...middleware.Middleware) *Router
  • func (r *Router) UseFunc(ms ...middleware.MiddlewareFunc) *Router

Variables

var DefaultRouter = NewDefaultRouter(ruler.DefaultRouter)

DefaultRouter is the default global router.

Types

type Router

type Router struct {
	// Middlewares is used to manage the middlewares and takes effect
	// before routing the request.
	Middlewares *middleware.Manager

	// Router is used to manage the routes.
	Router http.Handler
}

Router is a http router that manages all the http middlewares uniformly.

func NewDefaultRouter

func NewDefaultRouter(router http.Handler) *Router

NewDefaultRouter is the same as NewRouter, but also adds the default middlewares, that's middleware.DefaultMiddlewares.

func NewRouter

func NewRouter(router http.Handler) *Router

NewRouter returns a new Router with the next router handler.

func (*Router) ServeHTTP

func (r *Router) ServeHTTP(resp http.ResponseWriter, req *http.Request)

ServeHTTP implements the interface http.Handler.

func (*Router) Use

func (r *Router) Use(ms ...middleware.Middleware) *Router

Use appends a set of middlewares into the middleware manager.

func (*Router) UseFunc

func (r *Router) UseFunc(ms ...middleware.MiddlewareFunc) *Router

UseFunc appends a set of function middlewares into the middleware manager.