Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

router

package

Go to main page

Versions in this module

v1

v1.6.2

Mar 17, 2020

v1.6.1

Mar 17, 2020

Changes in this version

type Party

+ GetReporter func() *errors.Reporter

+ Macros func() *macro.Map

type Route

+ MainHandlerName string

v1.6.0

Mar 12, 2020

v1.0.1

Mar 12, 2020

Changes in this version

+ const MethodNone

+ const ParamStart

+ const SubdomainPrefix

+ const SubdomainWildcardIndicator

+ const SubdomainWildcardPrefix

+ const WildcardParamStart

+ var AllMethods = [...]string

+ var StaticCacheDuration = 20 * time.Second

+ func Abs(path string) string

+ func DirectoryExists(dir string) bool

+ func NewWrapper(...) http.Handler

+ func Param(name string) string

+ func StaticEmbeddedHandler(vdir string, assetFn func(name string) ([]byte, error), ...) context.Handler

+ func StaticHandler(systemPath string, showList bool, gzip bool) context.Handler

+ func StripPrefix(prefix string, h context.Handler) context.Handler

+ func TypeByExtension(ext string) (typ string)

+ func TypeByFilename(fullFilename string) string

+ func WildcardParam(name string) string

+ type APIBuilder struct

+ func NewAPIBuilder() *APIBuilder

+ func (api *APIBuilder) Any(relativePath string, handlers ...context.Handler) (routes []*Route)

+ func (api *APIBuilder) Connect(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Controller(relativePath string, controller activator.BaseController, ...) (routes []*Route)

+ func (api *APIBuilder) Delete(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Done(handlers ...context.Handler)

+ func (api *APIBuilder) Favicon(favPath string, requestPath ...string) *Route

+ func (api *APIBuilder) FireErrorCode(ctx context.Context)

+ func (api *APIBuilder) Get(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) GetReport() error

+ func (api *APIBuilder) GetReporter() *errors.Reporter

+ func (api *APIBuilder) GetRoute(routeName string) *Route

+ func (api *APIBuilder) GetRouteReadOnly(routeName string) context.RouteReadOnly

+ func (api *APIBuilder) GetRoutes() []*Route

+ func (api *APIBuilder) Handle(method string, relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) HandleMany(methodOrMulti string, relativePathorMulti string, handlers ...context.Handler) (routes []*Route)

+ func (api *APIBuilder) Head(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Layout(tmplLayoutFile string) Party

+ func (api *APIBuilder) Macros() *macro.Map

+ func (api *APIBuilder) None(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) OnAnyErrorCode(handlers ...context.Handler)

+ func (api *APIBuilder) OnErrorCode(statusCode int, handlers ...context.Handler)

+ func (api *APIBuilder) Options(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Party(relativePath string, handlers ...context.Handler) Party

+ func (api *APIBuilder) PartyFunc(relativePath string, partyBuilderFunc func(p Party)) Party

+ func (api *APIBuilder) Patch(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Post(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Put(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) StaticContent(reqPath string, cType string, content []byte) *Route

+ func (api *APIBuilder) StaticEmbedded(requestPath string, vdir string, assetFn func(name string) ([]byte, error), ...) *Route

+ func (api *APIBuilder) StaticEmbeddedHandler(vdir string, assetFn func(name string) ([]byte, error), ...) context.Handler

+ func (api *APIBuilder) StaticHandler(systemPath string, showList bool, gzip bool) context.Handler

+ func (api *APIBuilder) StaticServe(systemPath string, requestPath ...string) *Route

+ func (api *APIBuilder) StaticWeb(requestPath string, systemPath string) *Route

+ func (api *APIBuilder) Subdomain(subdomain string, middleware ...context.Handler) Party

+ func (api *APIBuilder) Trace(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Use(handlers ...context.Handler)

+ func (api *APIBuilder) UseGlobal(handlers ...context.Handler)

+ func (api *APIBuilder) WildcardSubdomain(middleware ...context.Handler) Party

+ type AssetValidator func(filename string) bool

+ type ErrorCodeHandler struct

+ Handlers context.Handlers

+ StatusCode int

+ func (ch *ErrorCodeHandler) Fire(ctx context.Context)

+ type ErrorCodeHandlers struct

+ func (s *ErrorCodeHandlers) Fire(ctx context.Context)

+ func (s *ErrorCodeHandlers) Get(statusCode int) *ErrorCodeHandler

+ func (s *ErrorCodeHandlers) Register(statusCode int, handlers ...context.Handler) *ErrorCodeHandler

+ type Party interface

+ Any func(registeredPath string, handlers ...context.Handler) []*Route

+ Connect func(path string, handlers ...context.Handler) *Route

+ Controller func(relativePath string, controller activator.BaseController, ...) []*Route

+ Delete func(path string, handlers ...context.Handler) *Route

+ Done func(handlers ...context.Handler)

+ Favicon func(favPath string, requestPath ...string) *Route

+ Get func(path string, handlers ...context.Handler) *Route

+ Handle func(method string, registeredPath string, handlers ...context.Handler) *Route

+ HandleMany func(method string, relativePath string, handlers ...context.Handler) []*Route

+ Head func(path string, handlers ...context.Handler) *Route

+ Layout func(tmplLayoutFile string) Party

+ None func(path string, handlers ...context.Handler) *Route

+ Options func(path string, handlers ...context.Handler) *Route

+ Party func(relativePath string, middleware ...context.Handler) Party

+ PartyFunc func(relativePath string, partyBuilderFunc func(p Party)) Party

+ Patch func(path string, handlers ...context.Handler) *Route

+ Post func(path string, handlers ...context.Handler) *Route

+ Put func(path string, handlers ...context.Handler) *Route

+ StaticContent func(requestPath string, cType string, content []byte) *Route

+ StaticEmbedded func(requestPath string, vdir string, assetFn func(name string) ([]byte, error), ...) *Route

+ StaticHandler func(systemPath string, showList bool, gzip bool) context.Handler

+ StaticServe func(systemPath string, requestPath ...string) *Route

+ StaticWeb func(requestPath string, systemPath string) *Route

+ Subdomain func(subdomain string, middleware ...context.Handler) Party

+ Trace func(path string, handlers ...context.Handler) *Route

+ Use func(middleware ...context.Handler)

+ type RequestHandler interface

+ Build func(provider RoutesProvider) error

+ HandleRequest func(context.Context)

+ func NewDefaultHandler() RequestHandler

+ type Route struct

+ FormattedPath string

+ Handlers context.Handlers

+ Method string

+ Name string

+ Path string

+ Subdomain string

+ func NewRoute(method, subdomain, unparsedPath, mainHandlerName string, ...) (*Route, error)

+ func (r *Route) BuildHandlers()

+ func (r Route) IsOnline() bool

+ func (r Route) ResolvePath(args ...string) string

+ func (r Route) StaticPath() string

+ func (r Route) String() string

+ func (r Route) Tmpl() macro.Template

+ func (r Route) Trace() string

+ type RoutePathReverser struct

+ func NewRoutePathReverser(apiRoutesProvider RoutesProvider, options ...RoutePathReverserOption) *RoutePathReverser

+ func (ps *RoutePathReverser) Path(routeName string, paramValues ...interface{}) string

+ func (ps *RoutePathReverser) URL(routeName string, paramValues ...interface{}) (url string)

+ type RoutePathReverserOption func(*RoutePathReverser)

+ func WithHost(host string) RoutePathReverserOption

+ func WithScheme(scheme string) RoutePathReverserOption

+ func WithServer(srv *http.Server) RoutePathReverserOption

+ type Router struct

+ func NewRouter() *Router

+ func (router *Router) BuildRouter(cPool *context.Pool, requestHandler RequestHandler, ...) error

+ func (router *Router) Downgrade(newMainHandler http.HandlerFunc)

+ func (router *Router) Downgraded() bool

+ func (router *Router) RefreshRouter() error

+ func (router *Router) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (router *Router) ServeHTTPC(ctx context.Context)

+ func (router *Router) WrapRouter(wrapperFunc WrapperFunc)

+ type RoutesProvider interface

+ GetRoute func(routeName string) *Route

+ GetRoutes func() []*Route

+ type SPABuilder struct

+ AssetHandler context.Handler

+ AssetValidators []AssetValidator

+ IndexNames []string

+ func NewSPABuilder(assetHandler context.Handler) *SPABuilder

+ func (s *SPABuilder) AddIndexName(filename string) *SPABuilder

+ func (s *SPABuilder) Handler(ctx context.Context)

+ type StaticHandlerBuilder interface

+ Build func() context.Handler

+ Gzip func(enable bool) StaticHandlerBuilder

+ Listing func(listDirectoriesOnOff bool) StaticHandlerBuilder

+ func NewStaticHandlerBuilder(dir string) StaticHandlerBuilder

+ type WrapperFunc func(w http.ResponseWriter, r *http.Request, firstNextIsTheRouter http.HandlerFunc)

v1.0.0

Mar 12, 2020