mux

Documentation

Index

• Constants
• type Config
• type ContextKey
• type Endpoint
  • func NewRouter(cfg *Config) (http.Handler, []*Endpoint)
• type Group
  • func (g *Group) Endpoint(method, path string, handler http.Handler)
  • func (g *Group) Middleware(fn func(http.Handler) http.Handler)
  • func (g *Group) Subgroup(fn func(g *Group))
• type Middleware

Constants

const (
	ParamsKey = ContextKey("params")
	PathKey   = ContextKey("path")
)

Types

type Config

type Config struct {
	RootGroup            *Group
	NotFoundHandler      http.Handler
	CommonPrefix         string
	PathSegmentValidator func(string) bool
	GlobalMiddlewares    []Middleware
}

type ContextKey

type ContextKey string

type Endpoint

type Endpoint struct {
	Method  string
	Path    string
	Handler http.Handler
}

func NewRouter

func NewRouter(cfg *Config) (http.Handler, []*Endpoint)

type Group

type Group struct {
	Middlewares []Middleware
	Endpoints   []*Endpoint
	Subgroups   []*Group
}

func (*Group) Endpoint

func (g *Group) Endpoint(method, path string, handler http.Handler)

func (*Group) Middleware

func (g *Group) Middleware(fn func(http.Handler) http.Handler)

func (*Group) Subgroup

func (g *Group) Subgroup(fn func(g *Group))

type Middleware

type Middleware func(http.Handler) http.Handler