validate

Documentation

Overview

Package validate provides utilities that allow to validate request and response data against OpenAPI Specification parameter and schema definitions.

Note that errors returned from validation functions are generally of type Error, so they can be asserted to corresponding interface(s) to retrieve error's field and value.

errs := validate.Query(ps, q)
for _, err := range errs {
    if e, ok := err.(validate.Error) {
        field, value := e.Field(), e.Value()
        // ...
    }
}

Index

• func Body(ps []spec.Parameter, data interface{}) []error
• func BySchema(sch *spec.Schema, data interface{}) []error
• func Query(ps []spec.Parameter, q url.Values) []error
• func RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
• type ValidationError
  • func ValidationErrorf(field string, value interface{}, format string, args ...interface{}) ValidationError
• type ValidationErrors
  • func (es ValidationErrors) Errors() []error

Functions

func Body

func Body(ps []spec.Parameter, data interface{}) []error

Body validates request body by spec and returns errors if any.

func BySchema

func BySchema(sch *spec.Schema, data interface{}) []error

BySchema validates data by spec and returns errors if any.

func Query

func Query(ps []spec.Parameter, q url.Values) []error

Query validates request query parameters by spec and returns errors if any.

func RegisterFormat

func RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers custom format and validator for it. See default OAS formatRegistry here: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types

Types

type ValidationError

type ValidationError interface {
	error

	// Field returns field name where error occurred.
	Field() string

	// Value returns original value passed by client on field where error
	// occurred.
	Value() interface{}
}

ValidationError describes validation error.

func ValidationErrorf

func ValidationErrorf(field string, value interface{}, format string, args ...interface{}) ValidationError

ValidationErrorf returns a new formatted ValidationError.

type ValidationErrors

type ValidationErrors []ValidationError

ValidationErrors is a set of validation errors.

func (ValidationErrors) Errors

func (es ValidationErrors) Errors() []error

Errors returns ValidationErrors in form of Go builtin errors.