v2

Documentation

Overview

Package v2 implements version 2 of the public API

Index

• func WriteError(w http.ResponseWriter, status int, err error)
• func WriteErrors(w http.ResponseWriter, status int, errs []error)
• type V2
  • func Init(Storage *storage.Manager, Scraper *scraper.Scraper, Config types.Config) *V2
  • func (v *V2) Routes() []types.Route
  • func (v *V2) Version() string

Functions

func WriteError

func WriteError(w http.ResponseWriter, status int, err error)

WriteError is a utility function for logging a request error and writing a response all in one.

func WriteErrors

func WriteErrors(w http.ResponseWriter, status int, errs []error)

WriteErrors does the same but for groups of errors

Types

type V2

type V2 struct {
	Storage *storage.Manager
	Scraper *scraper.Scraper
	Config  types.Config
}

V2 represents an API endpoint handler

func Init

func Init(Storage *storage.Manager, Scraper *scraper.Scraper, Config types.Config) *V2

Init initialises and returns a handler group

func (*V2) Routes

func (v *V2) Routes() []types.Route

Routes returns the version routes nolint:lll

func (*V2) Version

func (v *V2) Version() string

Version returns the route group version name