validator

README

validator

Table of contents

• Summary
• Input types
• Design
• Dependencies

Summary

This package provides JSON schema-based validation for JSON, YAML, and arbitrary Go values.

Input types

The following input types are supported.

• []byte - as JSON
• []byte - as YAML
• any

Design

Dependencies

Documentation

Index

• Variables
• type AnyValidator
• type DefaultValidator
  • func New() *DefaultValidator
  • func (v *DefaultValidator) ValidateAny(schema []byte, input any) ([]Error, error)
  • func (v *DefaultValidator) ValidateJSON(schema, input []byte) ([]Error, error)
  • func (v *DefaultValidator) ValidateYAML(schema, input []byte) ([]Error, error)
• type Error
• type JSONValidator
• type YAMLValidator

Variables

var ErrPkg = errors.New("validator")

ErrPkg a common package error.

Types

type AnyValidator

type AnyValidator interface {
	ValidateAny(schema []byte, input any) ([]Error, error)
}

AnyValidator validator interface.

type DefaultValidator

type DefaultValidator struct{}

DefaultValidator is a Validator service.

func New

func New() *DefaultValidator

New validator factory function.

func (*DefaultValidator) ValidateAny

func (v *DefaultValidator) ValidateAny(schema []byte, input any) ([]Error, error)

ValidateAny can be used to validate any type.

func (*DefaultValidator) ValidateJSON

func (v *DefaultValidator) ValidateJSON(schema, input []byte) ([]Error, error)

ValidateJSON can be used to validate JSON value.

func (*DefaultValidator) ValidateYAML

func (v *DefaultValidator) ValidateYAML(schema, input []byte) ([]Error, error)

ValidateYAML can be used to validate JSON value.

type Error

type Error struct {
	Field   string `json:"field"`
	Message string `json:"message"`
}

Error represents a validation error found.

type JSONValidator

type JSONValidator interface {
	ValidateJSON(schema, input []byte) ([]Error, error)
}

JSONValidator validator interface.

type YAMLValidator

type YAMLValidator interface {
	ValidateYAML(schema, input []byte) ([]Error, error)
}

YAMLValidator validator interface.