Documentation
¶
Overview ¶
Package routes contains the full set of handler functions and routes supported by the web api.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DebugMux ¶
func DebugMux(build string, log *zap.SugaredLogger) http.Handler
DebugMux registers all the debug standard library routes and then custom debug application routes for the service. This bypassing the use of the DefaultServerMux. Using the DefaultServerMux would be a security risk since a dependency could inject a handler into our service without us knowing it.
func DebugStandardLibraryMux ¶
DebugStandardLibraryMux registers all the debug routes from the standard library into a new mux bypassing the use of the DefaultServerMux. Using the DefaultServerMux would be a security risk since a dependency could inject a handler into our service without us knowing it.
func PrivateMux ¶
PrivateMux constructs a http.Handler with all application routes defined.
Types ¶
type MuxConfig ¶
type MuxConfig struct {
Shutdown chan os.Signal
Log *zap.SugaredLogger
State *state.State
NS *nameservice.NameService
Evts *events.Events
}
MuxConfig contains all the mandatory systems required by handlers.
Source Files