routing

Documentation

Index

• Constants
• func Add(rt *env.Runtime, prefix, path string, methods, queries []string, ...) error
• func AddPrivate(rt *env.Runtime, path string, methods, queries []string, endPtFn RouteFunc) error
• func AddPublic(rt *env.Runtime, path string, methods, queries []string, endPtFn RouteFunc) error
• 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

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/"
)

Functions

func Add

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

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

func AddPrivate

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

AddPrivate endpoint

func AddPublic

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

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