endpoints

Documentation

Index

• func HandleAlive() system.AliveHandlerFunc
• func HandleSearch(logger *zap.SugaredLogger, shakeSearcher *shakesearch.ShakeSearcher) public.ShakeSearchHandlerFunc
• func HandleWorks(logger *zap.SugaredLogger, shakeSearcher *shakesearch.ShakeSearcher, ...) public.ShakeWorksHandlerFunc

Functions

func HandleAlive

func HandleAlive() system.AliveHandlerFunc

HandleAlive creates and /api/alive endpoint handler via a closure.

func HandleSearch

func HandleSearch(logger *zap.SugaredLogger, shakeSearcher *shakesearch.ShakeSearcher) public.ShakeSearchHandlerFunc

HandleSearch creates a /api/search endpoint handler via a closure. It will do some basic cleaning of the query and respond with an array of results that contain some metadata.

func HandleWorks

func HandleWorks(logger *zap.SugaredLogger, shakeSearcher *shakesearch.ShakeSearcher, tmpl *template.Template) public.ShakeWorksHandlerFunc

HandleWorks creates a /api/works endpoint handler via a closure. It will create an HTML document of a snippet of the request line number of Shakespeare's works.