validator

Documentation

Index

• type JSONSchemaValidator
  • func NewJSONSchemaValidator(opts ...JSONSchemaValidatorOptionFunc) *JSONSchemaValidator
  • func (v *JSONSchemaValidator) ValidateDocument(schemaSource string, documentSource any) error
• type JSONSchemaValidatorOptionFunc
  • func AddHideErrorListTypeJSONSchemaValidatorOption(descType ...string) JSONSchemaValidatorOptionFunc
  • func SetSchemaStorageJSONSchemaValidatorOption(s Storage) JSONSchemaValidatorOptionFunc
• type OptionFunc
  • func SetJSONSchemaValidator(jsonSchema *JSONSchemaValidator) OptionFunc
  • func SetStructValidator(structValidator *StructValidator) OptionFunc
• type Storage
  • func NewFileLocalStorage(schemaLocationDir string) Storage
  • func NewFileSystemStorage(fileSystem fs.FS, rootPath string) Storage
  • func NewInMemStorage(schemaLocationDir string) Storage
• type StructValidator
  • func NewStructValidator(opts ...StructValidatorOptionFunc) *StructValidator
  • func (v *StructValidator) ValidateStruct(data any) error
• type StructValidatorOptionFunc
  • func SetCoreStructValidatorOption(additionalConfigFunc ...func(*validatorengine.Validate)) StructValidatorOptionFunc
• type Validator
  • func NewValidator(opts ...OptionFunc) *Validator
  • func (v *Validator) ValidateDocument(reference string, document any) error
  • func (v *Validator) ValidateStruct(data any) error

Types

type JSONSchemaValidator

type JSONSchemaValidator struct {
	SchemaStorage Storage
	// contains filtered or unexported fields
}

JSONSchemaValidator validator

func NewJSONSchemaValidator

func NewJSONSchemaValidator(opts ...JSONSchemaValidatorOptionFunc) *JSONSchemaValidator

NewJSONSchemaValidator constructor

func (*JSONSchemaValidator) ValidateDocument

func (v *JSONSchemaValidator) ValidateDocument(schemaSource string, documentSource any) error

ValidateDocument based on schema id

type JSONSchemaValidatorOptionFunc

type JSONSchemaValidatorOptionFunc func(*JSONSchemaValidator)

JSONSchemaValidatorOptionFunc type

func AddHideErrorListTypeJSONSchemaValidatorOption

func AddHideErrorListTypeJSONSchemaValidatorOption(descType ...string) JSONSchemaValidatorOptionFunc

AddHideErrorListTypeJSONSchemaValidatorOption option func

func SetSchemaStorageJSONSchemaValidatorOption

func SetSchemaStorageJSONSchemaValidatorOption(s Storage) JSONSchemaValidatorOptionFunc

SetSchemaStorageJSONSchemaValidatorOption option func

type OptionFunc

type OptionFunc func(*Validator)

OptionFunc type

func SetJSONSchemaValidator

func SetJSONSchemaValidator(jsonSchema *JSONSchemaValidator) OptionFunc

SetJSONSchemaValidator option func

func SetStructValidator

func SetStructValidator(structValidator *StructValidator) OptionFunc

SetStructValidator option func

type Storage

type Storage interface {
	Get(schemaID string) (string, error)
	Store(schemaID string, schema string) error
}

Storage abstraction

func NewFileLocalStorage

func NewFileLocalStorage(schemaLocationDir string) Storage

NewFileLocalStorage read from file

func NewFileSystemStorage

func NewFileSystemStorage(fileSystem fs.FS, rootPath string) Storage

NewFileSystemStorage constructor

func NewInMemStorage

func NewInMemStorage(schemaLocationDir string) Storage

NewInMemStorage constructor

type StructValidator

type StructValidator struct {
	Validator *validatorengine.Validate
}

StructValidator struct

func NewStructValidator

func NewStructValidator(opts ...StructValidatorOptionFunc) *StructValidator

NewStructValidator using go library https://github.com/go-playground/validator (all struct tags will be here) https://godoc.org/github.com/go-playground/validator (documentation using it) NewStructValidator function

func (*StructValidator) ValidateStruct

func (v *StructValidator) ValidateStruct(data any) error

ValidateStruct function

type StructValidatorOptionFunc

type StructValidatorOptionFunc func(*StructValidator)

StructValidatorOptionFunc type

func SetCoreStructValidatorOption

func SetCoreStructValidatorOption(additionalConfigFunc ...func(*validatorengine.Validate)) StructValidatorOptionFunc

SetCoreStructValidatorOption option func

type Validator

type Validator struct {
	JSONSchema      *JSONSchemaValidator
	StructValidator *StructValidator
}

Validator instance

func NewValidator

func NewValidator(opts ...OptionFunc) *Validator

NewValidator constructor, using jsonschema & struct validator (github.com/go-playground/validator), jsonschema source file load from "api/jsonschema" directory

func (*Validator) ValidateDocument

func (v *Validator) ValidateDocument(reference string, document any) error

ValidateDocument method using jsonschema with input is json source

func (*Validator) ValidateStruct

func (v *Validator) ValidateStruct(data any) error

ValidateStruct method, rules from struct tag using github.com/go-playground/validator