routing

package

v3.2.0+incompatible Latest Latest Go to latest Published: Aug 29, 2019 License: AGPL-3.0 Imports: 33 Imported by: 3

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/documize/community

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Add(rt *env.Runtime, prefix, path string, methods, queries []string, ...)
func AddPrivate(rt *env.Runtime, path string, methods, queries []string, endPtFn RouteFunc)
func AddPublic(rt *env.Runtime, path string, methods, queries []string, endPtFn RouteFunc)
func BuildRoutes(rt *env.Runtime, prefix string) *mux.Router
func RegisterEndpoints(rt *env.Runtime, s *store.Store)
func Remove(rt *env.Runtime, prefix, path string, methods, queries []string) error
type RouteFunc

Constants ¶

View Source

const (
	// RoutePrefixPublic used for the unsecured api
	RoutePrefixPublic = "/api/public/"
	// RoutePrefixPrivate used for secured api (requiring api)
	RoutePrefixPrivate = "/api/"
	// RoutePrefixRoot used for unsecured endpoints at root (e.g. robots.txt)
	RoutePrefixRoot = "/"
	// RoutePrefixTesting used for isolated testing of routes with custom middleware
	RoutePrefixTesting = "/testing/"
)

Variables ¶

This section is empty.

Functions ¶

func Add ¶

func Add(rt *env.Runtime, prefix, path string, methods, queries []string, endPtFn RouteFunc)

Add an endpoint to those that will be processed when Serve() is called.

func AddPrivate ¶ added in v1.59.0

func AddPrivate(rt *env.Runtime, path string, methods, queries []string, endPtFn RouteFunc)

AddPrivate endpoint

func AddPublic ¶ added in v1.59.0

func AddPublic(rt *env.Runtime, path string, methods, queries []string, endPtFn RouteFunc)

AddPublic endpoint

func BuildRoutes ¶

func BuildRoutes(rt *env.Runtime, prefix string) *mux.Router

BuildRoutes returns all matching routes for specified scope.

func RegisterEndpoints ¶

func RegisterEndpoints(rt *env.Runtime, s *store.Store)

RegisterEndpoints register routes for serving API endpoints

func Remove ¶

func Remove(rt *env.Runtime, prefix, path string, methods, queries []string) error

Remove an endpoint.

Types ¶

type RouteFunc ¶

type RouteFunc func(http.ResponseWriter, *http.Request)

RouteFunc describes end-point functions

Source Files ¶

View all Source files

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