web

type API ¶

type API struct {
	// contains filtered or unexported fields
}

API represents a web application that hosts a REST API.

func NewAPI(shutdown chan os.Signal, middlewares ...Middleware) *API

func (a *API) Register(method, group, path string, handler Handler, middlewares ...Middleware)

func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (a *API) SignalShutdown()

type App ¶

type App struct {
	// contains filtered or unexported fields
}

func NewApp(api *API, uiFileReader FileReader, logger *logrus.Logger) *App

func (a *App) ServeHTTP(w http.ResponseWriter, r *http.Request)

type CtxValues ¶

type CtxValues struct {
	Path       string
	Now        time.Time
	StatusCode int
}

CtxValues represent state for each request.

func GetContextValues(ctx context.Context) (*CtxValues, error)

type FileReader ¶

type FileReader interface {
	ReadFile(name string) ([]byte, error)
}

type Handler ¶

type Handler func(context.Context, http.ResponseWriter, *http.Request, httprouter.Params) error

Handler extends the http.HandlerFunc buy adding a context, params and an error to return.

type Middleware ¶

type Middleware func(Handler) Handler

Middleware is a func type that wraps around handlers. These funcs or executed before or after the handler.

type RequestError ¶

type RequestError struct {
	ErrMessage string
	Status     int
}

RequestError represents an error with an HTTP status code.

func (r *RequestError) Error() string