handlers

Documentation

Overview

Package handlers contains the full set of handler functions and routes supported by the web api.

Index

• func DebugMux(build string, gqlConfig data.GraphQLConfig) http.Handler
• func DebugStandardLibraryMux() *http.ServeMux
• func UIMux(build string, shutdown chan os.Signal, log *log.Logger, ...) (*web.App, error)

Functions

func DebugMux

func DebugMux(build string, gqlConfig data.GraphQLConfig) 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

func DebugStandardLibraryMux() *http.ServeMux

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 UIMux

func UIMux(build string, shutdown chan os.Signal, log *log.Logger, metrics *metrics.Metrics, gqlConfig data.GraphQLConfig, browserEndpoint string, mapsKey string) (*web.App, error)

UIMux constructs an http.Handler with all application routes defined.