whroute

package

v1.0.0-...-3f30213 Latest Latest Go to latest Published: May 30, 2017 License: Apache-2.0 Imports: 4 Imported by: 30

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-webhelp/webhelp

Links

Open Source Insights

Documentation ¶

Overview ¶

Package whroute provides utilities to implement route listing, whereby http.Handlers that opt in can list what routes they understand.

Index ¶

Constants
func HandlerFunc(routes http.Handler, fn func(http.ResponseWriter, *http.Request)) http.Handler
func PrintRoutes(out io.Writer, h http.Handler) (err error)
func Routes(h http.Handler, cb func(method, path string, annotations map[string]string))
type Lister

Constants ¶

View Source

const (
	// AllMethods should be returned from a whroute.Lister when all methods are
	// successfully handled.
	AllMethods = "ALL"

	// AllPaths should be returned from a whroute.Lister when all paths are
	// successfully handled.
	AllPaths = "[/<*>]"
)

Variables ¶

This section is empty.

Functions ¶

func HandlerFunc ¶

func HandlerFunc(routes http.Handler,
	fn func(http.ResponseWriter, *http.Request)) http.Handler

HandlerFunc advertises the routes from routes, but serves content using fn.

func PrintRoutes ¶

func PrintRoutes(out io.Writer, h http.Handler) (err error)

PrintRoutes will write all routes of h to out, using the Routes method.

func Routes ¶

func Routes(h http.Handler,
	cb func(method, path string, annotations map[string]string))

Routes will call cb with all routes known to h.

Types ¶

type Lister ¶

type Lister interface {
	Routes(cb func(method, path string, annotations map[string]string))
}

Lister is an interface handlers can implement if they want the Routes method to work. All http.Handlers in the webhelp package implement Routes.

Source Files ¶

View all Source files

routes.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL