web

Documentation

Index

• Variables
• func AddTagParsers(parser tagParser)
• func CheckErrors(opts ValidateParams) (ok bool, err error)
• func NewBinder(v Validator) echo.Binder
• func NewEngine(params EngineParams) *echo.Echo
• func NewLogger(log *zap.Logger) echo.Logger
• func NewMultiServer(params MultiServerParams) mserv.Server
• type APIParams
• type CustomError
• type EmptyWriter
  • func (EmptyWriter) Write(data []byte) (int, error)
• type EngineParams
• type FieldError
  • func (f FieldError) Error() string
• type FieldLevel
• type Func
• type MultiServerParams
• type ServerResult
  • func NewAPIServer(v *viper.Viper, l logger.StdLogger, h http.Handler) ServerResult
  • func NewMetricsServer(v *viper.Viper, l logger.StdLogger) ServerResult
  • func NewPprofServer(v *viper.Viper, l logger.StdLogger) ServerResult
• type ValidateParams
• type Validator
  • func NewValidator() Validator
  • func WrapValidator(v *validator.Validate) Validator

Variables

var EngineModule = module.Module{
	{Constructor: NewValidator},
	{Constructor: NewBinder},
	{Constructor: NewEngine},
}

var Null = new(EmptyWriter)

Null is /dev/null emulation

var (
	// ServersModule of web base structs
	ServersModule = module.Module{
		{Constructor: NewAPIServer},
		{Constructor: NewMetricsServer},
		{Constructor: NewPprofServer},
		{Constructor: NewMultiServer},
	}
)

Functions

func AddTagParsers

func AddTagParsers(parser tagParser)

AddTagParsers used in fieldName

func CheckErrors

func CheckErrors(opts ValidateParams) (ok bool, err error)

CheckErrors of validator and return formatted errors:

func NewBinder

func NewBinder(v Validator) echo.Binder

NewBinder returns custom echo.Binder

func NewEngine

func NewEngine(params EngineParams) *echo.Echo

NewEngine returns configured echo engine

func NewLogger

func NewLogger(log *zap.Logger) echo.Logger

NewLogger converts zap.Logger to echo.Logger

func NewMultiServer

func NewMultiServer(params MultiServerParams) mserv.Server

NewMultiServer returns new multi servers group

Types

type APIParams

type APIParams struct {
	dig.In

	Config  *viper.Viper
	Logger  logger.StdLogger
	Handler http.Handler `optional:"true"`
}

APIParams struct

type CustomError

type CustomError interface {
	FormatResponse(ctx echo.Context) error
}

CustomError interface

type EmptyWriter

type EmptyWriter struct{}

EmptyWriter struct

func (EmptyWriter) Write

func (EmptyWriter) Write(data []byte) (int, error)

Write /dev/null emulation

type EngineParams

type EngineParams struct {
	dig.In

	Config     *viper.Viper   `optional:"true"`
	Binder     echo.Binder    `optional:"true"`
	Logger     *zap.Logger    `optional:"true"`
	EchoLogger echo.Logger    `optional:"true"`
	Validator  echo.Validator `optional:"true"`
}

EngineParams struct

type FieldError

type FieldError struct {
	Field     string
	Message   string
	Validator validator.FieldError
}

FieldError contains field name and validator error

func (FieldError) Error

func (f FieldError) Error() string

type FieldLevel

type FieldLevel = validator.FieldLevel

FieldLevel contains all the information and helper functions to validate a field

type Func

type Func = validator.Func

Func accepts a FieldLevel interface for all validation needs. The return value should be true when validation succeeds.

type MultiServerParams

type MultiServerParams struct {
	dig.In

	Logger  logger.StdLogger
	Servers []mserv.Server `group:"web_server"`
}

MultiServerParams struct

type ServerResult

type ServerResult struct {
	dig.Out

	Server mserv.Server `group:"web_server"`
}

ServerResult struct

func NewAPIServer

func NewAPIServer(v *viper.Viper, l logger.StdLogger, h http.Handler) ServerResult

NewAPIServer creates api server by http.Handler from DI container

func NewMetricsServer

func NewMetricsServer(v *viper.Viper, l logger.StdLogger) ServerResult

NewMetricsServer returns wrapped prometheus http server

func NewPprofServer

func NewPprofServer(v *viper.Viper, l logger.StdLogger) ServerResult

NewPprofServer returns wrapped pprof http server

type ValidateParams

type ValidateParams struct {
	Struct    interface{}
	Errors    error
	Formatter func(fields []*FieldError) string
}

ValidateParams to call CheckErrors method

type Validator

type Validator interface {
	Validate(i interface{}) error
	Register(tag string, fn Func) error
}

Validator to implement custom echo.Validator

func NewValidator

func NewValidator() Validator

NewValidator returns custom echo.Validator

func WrapValidator

func WrapValidator(v *validator.Validate) Validator

WrapValidator wraps v9.validator