README
¶
Routes
Routes is a Go module for adding the common routes to an existing handler.
At the moment those routes consist of:
- /health
- /version
These endpoints are for readiness and liveness as well as telling us what version of the code is running at any given time.
Documentation
¶
Index ¶
- func AddCommonRoutes(router *mux.Router, buildInfo Config, interfacesForExpansion ...interface{}) (readyFn server.UpdateFn, livenessFn server.UpdateFn)
- func HealthHandler(rw http.ResponseWriter, _ *http.Request)
- func VersionHandler(v, c, bn, e string, interfacesForExpansion ...interface{}) http.HandlerFunc
- type Config
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddCommonRoutes ¶
func AddCommonRoutes(router *mux.Router, buildInfo Config, interfacesForExpansion ...interface{}) (readyFn server.UpdateFn, livenessFn server.UpdateFn)
Calling this from when setting up the router will add these common endpoints. Readiness and liveness update functions returned.
func HealthHandler ¶
func HealthHandler(rw http.ResponseWriter, _ *http.Request)
Add here all default behaviour for all/most routes
func VersionHandler ¶
func VersionHandler(v, c, bn, e string, interfacesForExpansion ...interface{}) http.HandlerFunc
Types ¶
Source Files
Click to show internal directories.
Click to hide internal directories.