web

Documentation

Index

• Constants
• func ContextMiddleware(db *database.Database) echo.MiddlewareFunc
• func ParseAndValidate(ctx *echo.Context, target interface{}) error
• func PrometheusMiddleware(srv *echo.Echo)
• func VersionHeaderMiddleware(next echo.HandlerFunc) echo.HandlerFunc
• type GoposContext
• type Validator
  • func (v Validator) Validate(i interface{}) error

Constants

const HeaderVersion = "X-Gopos-Version"

HeaderVersion HTTP Header that includes the current version.

Functions

func ContextMiddleware

func ContextMiddleware(db *database.Database) echo.MiddlewareFunc

ContextMiddleware provides the GoposContext as a middleware function.

func ParseAndValidate

func ParseAndValidate(ctx *echo.Context, target interface{}) error

ParseAndValidate parses the request and applies data validation.

func PrometheusMiddleware

func PrometheusMiddleware(srv *echo.Echo)

PrometheusMiddleware registers the Prometheus middleware on the server.

func VersionHeaderMiddleware

func VersionHeaderMiddleware(next echo.HandlerFunc) echo.HandlerFunc

VersionHeaderMiddleware adds the current Gopos version to every HTTP response.

Types

type GoposContext

type GoposContext struct {
	DB *database.Database

	echo.Context
}

GoposContext custom context that exposes the database instance to routes.

type Validator

type Validator struct {
	Validator *validator.Validate
}

Validator default request validator

func (Validator) Validate

func (v Validator) Validate(i interface{}) error