Documentation
¶
Overview ¶
Package handlers manages the different versions of the 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
Directories
¶
| Path | Synopsis |
|---|---|
|
debug
|
|
|
checkgrp
Package checkgrp maintains the group of handlers for health checking.
|
Package checkgrp maintains the group of handlers for health checking. |
|
Package v1 contains the full set of handler functions and routes supported by the v1 web api.
|
Package v1 contains the full set of handler functions and routes supported by the v1 web api. |
|
private
Package private maintains the group of handlers for node to node access.
|
Package private maintains the group of handlers for node to node access. |
|
public
Package public maintains the group of handlers for public access.
|
Package public maintains the group of handlers for public access. |