echo

README

Echo module for Helium

Module provides boilerplate that preconfigured echo.Engine for you with custom Binder / Logger / Validator / ErrorHandler

• bind - simple replacement for echo.Binder
• validate - simple replacement for echo.Validate
• logger - provides echo.Logger that pass calls to zap.Logger

Documentation

Index

• Variables
• func AddTagParsers(parser tagParser)
• func CheckErrors(opts ValidateParams) (ok bool, err error)
• func LoggerMiddleware(log *zap.Logger) echo.MiddlewareFunc
• func NewBinder(v Validator) echo.Binder
• func NewEngine(params EngineParams) *echo.Echo
• func NewLogger(log *zap.Logger) echo.Logger
• type CustomError
• type EngineParams
• type FieldError
  • func (f FieldError) Error() string
• type FieldLevel
• type Func
• type ValidateParams
• type Validator
  • func NewValidator() Validator
  • func WrapValidator(v *validator.Validate) Validator

Variables

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

Module engine

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 LoggerMiddleware

func LoggerMiddleware(log *zap.Logger) echo.MiddlewareFunc

LoggerMiddleware returns a middleware that logs HTTP requests.

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

Types

type CustomError

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

CustomError interface

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 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