handlers

Documentation

Index

• func DebugMux(build string, log *zap.SugaredLogger) http.Handler
• func PrivateMux(cfg MuxConfig) http.Handler
• func PublicMux(cfg MuxConfig) http.Handler
• type MuxConfig

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 PrivateMux

func PrivateMux(cfg MuxConfig) http.Handler

PrivateMux constructs a http.Handler with all application routes defined.

func PublicMux

func PublicMux(cfg MuxConfig) http.Handler

PublicMux constructs a http.Handler with all application routes defined.

Types

type MuxConfig

type MuxConfig struct {
	Shutdown chan os.Signal
	Log      *zap.SugaredLogger
}

MuxConfig contains all the mandatory systems required by handlers.