routing

Documentation

Index

• Variables
• func SetupRoutes() *mux.Router
• type DefinitionHandlerType
• type HealthCheck

Variables

var DefinitionHandlerProvider = &DefinitionHandlerType{Provider: &urbanDictionary.DefinitionProvider{}}

DefinitionHandlerProvider - The service that will provide definitions

Functions

func SetupRoutes

func SetupRoutes() *mux.Router

SetupRoutes - Sets up all routes for the service

Types

type DefinitionHandlerType

type DefinitionHandlerType struct {
	Provider types.DefinitionProvider
}

DefinitionHandlerType - Set the type of provider to use for definitions

type HealthCheck

type HealthCheck struct {
	Status  string `json:"status"`
	Version string `json:"version"`
	Commit  string `json:"commit"`
	Branch  string `json:"branch"`
}

HealthCheck - response format for health handler