Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jsonschema

package module

Go to main page

Versions in this module

v0

v0.2.7

Jan 4, 2024

v0.2.6

Jan 4, 2024

v0.2.5

Jan 4, 2024

v0.2.4

Jul 21, 2023

v0.2.3

Jul 21, 2023

v0.2.2

Jul 21, 2023

Changes in this version

+ type JsonApiWrap struct

+ Data interface{}

v0.2.1

Jul 21, 2023

v0.2.0

Jul 19, 2023

v0.1.0

Jul 18, 2023

Changes in this version

+ const Array

+ const Boolean

+ const DateLayout

+ const ErrSkipProperty

+ const Integer

+ const Null

+ const Number

+ const Object

+ const String

+ const XEnumNames

+ func CollectDefinitions(f func(name string, schema Schema)) func(*ReflectContext)

+ func DefinitionsPrefix(prefix string) func(*ReflectContext)

+ func InlineRefs(rc *ReflectContext)

+ func InterceptNullability(f InterceptNullabilityFunc) func(reflectContext *ReflectContext)

+ func InterceptProp(f InterceptPropFunc) func(reflectContext *ReflectContext)

+ func InterceptProperty(f InterceptPropertyFunc) func(*ReflectContext)

+ func InterceptSchema(f InterceptSchemaFunc) func(*ReflectContext)

+ func InterceptType(f InterceptTypeFunc) func(*ReflectContext)

+ func MakePropertyNameMapping(v interface{}, tagName string) map[string]string

+ func ProcessWithoutTags(rc *ReflectContext)

+ func PropertyNameMapping(mapping map[string]string) func(rc *ReflectContext)

+ func PropertyNameTag(tag string, additional ...string) func(*ReflectContext)

+ func RootNullable(rc *ReflectContext)

+ func RootRef(rc *ReflectContext)

+ func SkipEmbeddedMapsSlices(rc *ReflectContext)

+ func SkipUnsupportedProperties(rc *ReflectContext)

+ func StripDefinitionNamePrefix(prefix ...string) func(rc *ReflectContext)

+ type AllOfExposer interface

+ JSONSchemaAllOf func() []interface{}

+ func AllOf(v ...interface{}) AllOfExposer

+ type AnyOfExposer interface

+ JSONSchemaAnyOf func() []interface{}

+ func AnyOf(v ...interface{}) AnyOfExposer

+ type Date time.Time

+ func (d *Date) UnmarshalJSON(data []byte) error

+ func (d *Date) UnmarshalText(data []byte) error

+ func (d Date) MarshalJSON() ([]byte, error)

+ func (d Date) MarshalText() ([]byte, error)

+ type DependenciesAdditionalProperties struct

+ SchemaOrBool *SchemaOrBool

+ StringArray []string

+ func (d *DependenciesAdditionalProperties) SchemaOrBoolEns() *SchemaOrBool

+ func (d *DependenciesAdditionalProperties) UnmarshalJSON(data []byte) error

+ func (d *DependenciesAdditionalProperties) WithSchemaOrBool(val SchemaOrBool) *DependenciesAdditionalProperties

+ func (d *DependenciesAdditionalProperties) WithStringArray(val ...string) *DependenciesAdditionalProperties

+ func (d DependenciesAdditionalProperties) MarshalJSON() ([]byte, error)

+ type Described interface

+ Description func() string

+ type ElseExposer interface

+ JSONSchemaElse func() interface{}

+ type Enum interface

+ Enum func() []interface{}

+ type Exposer interface

+ JSONSchema func() (Schema, error)

+ type IfExposer interface

+ JSONSchemaIf func() interface{}

+ type IgnoreTypeName interface

+ IgnoreTypeName func()

+ type InterceptNullabilityFunc func(params InterceptNullabilityParams)

+ type InterceptNullabilityParams struct

+ Context *ReflectContext

+ NullAdded bool

+ OmitEmpty bool

+ OrigSchema Schema

+ RefDef *Schema

+ Schema *Schema

+ Type reflect.Type

+ type InterceptPropFunc func(params InterceptPropParams) error

+ type InterceptPropParams struct

+ Context *ReflectContext

+ Field reflect.StructField

+ Name string

+ Path []string

+ Processed bool

+ PropertySchema *Schema

+ type InterceptPropertyFunc func(name string, field reflect.StructField, propertySchema *Schema) error

+ type InterceptSchemaFunc func(params InterceptSchemaParams) (stop bool, err error)

+ type InterceptSchemaParams struct

+ Context *ReflectContext

+ Processed bool

+ Schema *Schema

+ Value reflect.Value

+ type InterceptTypeFunc func(reflect.Value, *Schema) (stop bool, err error)

+ type Items struct

+ SchemaArray []SchemaOrBool

+ SchemaOrBool *SchemaOrBool

+ func (i *Items) SchemaOrBoolEns() *SchemaOrBool

+ func (i *Items) UnmarshalJSON(data []byte) error

+ func (i *Items) WithSchemaArray(val ...SchemaOrBool) *Items

+ func (i *Items) WithSchemaOrBool(val SchemaOrBool) *Items

+ func (i Items) MarshalJSON() ([]byte, error)

+ type NamedEnum interface

+ NamedEnum func() ([]interface{}, []string)

+ type NotExposer interface

+ JSONSchemaNot func() interface{}

+ type OneOfExposer interface

+ JSONSchemaOneOf func() []interface{}

+ func OneOf(v ...interface{}) OneOfExposer

+ type Preparer interface

+ PrepareJSONSchema func(schema *Schema) error

+ type RawExposer interface

+ JSONSchemaBytes func() ([]byte, error)

+ type Ref struct

+ Name string

+ Path string

+ func (r Ref) Schema() Schema

+ type ReflectContext struct

+ CollectDefinitions func(name string, schema Schema)

+ DefName func(t reflect.Type, defaultDefName string) string

+ DefinitionsPrefix string

+ EnvelopNullability bool

+ InlineRefs bool

+ InterceptNullability InterceptNullabilityFunc

+ InterceptProperty InterceptPropertyFunc

+ InterceptType InterceptTypeFunc

+ Path []string

+ ProcessWithoutTags bool

+ PropertyNameAdditionalTags []string

+ PropertyNameMapping map[string]string

+ PropertyNameTag string

+ RootNullable bool

+ RootRef bool

+ SkipEmbeddedMapsSlices bool

+ SkipNonConstraints bool

+ SkipUnsupportedProperties bool

+ UnnamedFieldWithTag bool

+ type Reflector struct

+ DefaultOptions []func(*ReflectContext)

+ func (r *Reflector) AddTypeMapping(src, dst interface{})

+ func (r *Reflector) InlineDefinition(sample interface{})

+ func (r *Reflector) InterceptDefName(f func(t reflect.Type, defaultDefName string) string)

+ func (r *Reflector) Reflect(i interface{}, options ...func(rc *ReflectContext)) (Schema, error)

+ type Schema struct

+ AdditionalItems *SchemaOrBool

+ AdditionalProperties *SchemaOrBool

+ AllOf []SchemaOrBool

+ AnyOf []SchemaOrBool

+ Comment *string

+ Const *interface{}

+ Contains *SchemaOrBool

+ ContentEncoding *string

+ ContentMediaType *string

+ Default *interface{}

+ Definitions map[string]SchemaOrBool

+ Dependencies map[string]DependenciesAdditionalProperties

+ Description *string

+ Else *SchemaOrBool

+ Enum []interface{}

+ Examples []interface{}

+ ExclusiveMaximum *float64

+ ExclusiveMinimum *float64

+ ExtraProperties map[string]interface{}

+ Format *string

+ ID *string

+ If *SchemaOrBool

+ Items *Items

+ MaxItems *int64

+ MaxLength *int64

+ MaxProperties *int64

+ Maximum *float64

+ MinItems int64

+ MinLength int64

+ MinProperties int64

+ Minimum *float64

+ MultipleOf *float64

+ Not *SchemaOrBool

+ OneOf []SchemaOrBool

+ Parent *Schema

+ Pattern *string

+ PatternProperties map[string]SchemaOrBool

+ Properties map[string]SchemaOrBool

+ PropertyNames *SchemaOrBool

+ ReadOnly *bool

+ Ref *string

+ ReflectType reflect.Type

+ Required []string

+ Schema *string

+ Then *SchemaOrBool

+ Title *string

+ Type *Type

+ UniqueItems *bool

+ func (s *Schema) AddType(t SimpleType)

+ func (s *Schema) AdditionalItemsEns() *SchemaOrBool

+ func (s *Schema) AdditionalPropertiesEns() *SchemaOrBool

+ func (s *Schema) ContainsEns() *SchemaOrBool

+ func (s *Schema) ElseEns() *SchemaOrBool

+ func (s *Schema) HasType(t SimpleType) bool

+ func (s *Schema) IfEns() *SchemaOrBool

+ func (s *Schema) ItemsEns() *Items

+ func (s *Schema) NotEns() *SchemaOrBool

+ func (s *Schema) PropertyNamesEns() *SchemaOrBool

+ func (s *Schema) ThenEns() *SchemaOrBool

+ func (s *Schema) ToSchemaOrBool() SchemaOrBool

+ func (s *Schema) TypeEns() *Type

+ func (s *Schema) UnmarshalJSON(data []byte) error

+ func (s *Schema) WithAdditionalItems(val SchemaOrBool) *Schema

+ func (s *Schema) WithAdditionalProperties(val SchemaOrBool) *Schema

+ func (s *Schema) WithAllOf(val ...SchemaOrBool) *Schema

+ func (s *Schema) WithAnyOf(val ...SchemaOrBool) *Schema

+ func (s *Schema) WithComment(val string) *Schema

+ func (s *Schema) WithConst(val interface{}) *Schema

+ func (s *Schema) WithContains(val SchemaOrBool) *Schema

+ func (s *Schema) WithContentEncoding(val string) *Schema

+ func (s *Schema) WithContentMediaType(val string) *Schema

+ func (s *Schema) WithDefault(val interface{}) *Schema

+ func (s *Schema) WithDefinitions(val map[string]SchemaOrBool) *Schema

+ func (s *Schema) WithDefinitionsItem(key string, val SchemaOrBool) *Schema

+ func (s *Schema) WithDependencies(val map[string]DependenciesAdditionalProperties) *Schema

+ func (s *Schema) WithDependenciesItem(key string, val DependenciesAdditionalProperties) *Schema

+ func (s *Schema) WithDescription(val string) *Schema

+ func (s *Schema) WithElse(val SchemaOrBool) *Schema

+ func (s *Schema) WithEnum(val ...interface{}) *Schema

+ func (s *Schema) WithExamples(val ...interface{}) *Schema

+ func (s *Schema) WithExclusiveMaximum(val float64) *Schema

+ func (s *Schema) WithExclusiveMinimum(val float64) *Schema

+ func (s *Schema) WithExtraProperties(val map[string]interface{}) *Schema

+ func (s *Schema) WithExtraPropertiesItem(key string, val interface{}) *Schema

+ func (s *Schema) WithFormat(val string) *Schema

+ func (s *Schema) WithID(val string) *Schema

+ func (s *Schema) WithIf(val SchemaOrBool) *Schema

+ func (s *Schema) WithItems(val Items) *Schema

+ func (s *Schema) WithMaxItems(val int64) *Schema

+ func (s *Schema) WithMaxLength(val int64) *Schema

+ func (s *Schema) WithMaxProperties(val int64) *Schema

+ func (s *Schema) WithMaximum(val float64) *Schema

+ func (s *Schema) WithMinItems(val int64) *Schema

+ func (s *Schema) WithMinLength(val int64) *Schema

+ func (s *Schema) WithMinProperties(val int64) *Schema

+ func (s *Schema) WithMinimum(val float64) *Schema

+ func (s *Schema) WithMultipleOf(val float64) *Schema

+ func (s *Schema) WithNot(val SchemaOrBool) *Schema

+ func (s *Schema) WithOneOf(val ...SchemaOrBool) *Schema

+ func (s *Schema) WithPattern(val string) *Schema

+ func (s *Schema) WithPatternProperties(val map[string]SchemaOrBool) *Schema

+ func (s *Schema) WithPatternPropertiesItem(key string, val SchemaOrBool) *Schema

+ func (s *Schema) WithProperties(val map[string]SchemaOrBool) *Schema

+ func (s *Schema) WithPropertiesItem(key string, val SchemaOrBool) *Schema

+ func (s *Schema) WithPropertyNames(val SchemaOrBool) *Schema

+ func (s *Schema) WithReadOnly(val bool) *Schema

+ func (s *Schema) WithRef(val string) *Schema

+ func (s *Schema) WithRequired(val ...string) *Schema

+ func (s *Schema) WithSchema(val string) *Schema

+ func (s *Schema) WithThen(val SchemaOrBool) *Schema

+ func (s *Schema) WithTitle(val string) *Schema

+ func (s *Schema) WithType(val Type) *Schema

+ func (s *Schema) WithUniqueItems(val bool) *Schema

+ func (s Schema) IgnoreTypeName()

+ func (s Schema) IsTrivial(refResolvers ...func(string) (SchemaOrBool, bool)) bool

+ func (s Schema) JSONSchema() (Schema, error)

+ func (s Schema) JSONSchemaBytes() ([]byte, error)

+ func (s Schema) MarshalJSON() ([]byte, error)

+ type SchemaInliner interface

+ InlineJSONSchema func()

+ type SchemaOrBool struct

+ TypeBoolean *bool

+ TypeObject *Schema

+ func (s *SchemaOrBool) FromSimpleMap(m map[string]interface{}) error

+ func (s *SchemaOrBool) TypeObjectEns() *Schema

+ func (s *SchemaOrBool) UnmarshalJSON(data []byte) error

+ func (s *SchemaOrBool) WithTypeBoolean(val bool) *SchemaOrBool

+ func (s *SchemaOrBool) WithTypeObject(val Schema) *SchemaOrBool

+ func (s SchemaOrBool) IsTrivial(refResolvers ...func(string) (SchemaOrBool, bool)) bool

+ func (s SchemaOrBool) JSONSchemaBytes() ([]byte, error)

+ func (s SchemaOrBool) MarshalJSON() ([]byte, error)

+ func (s SchemaOrBool) ToSimpleMap() (map[string]interface{}, error)

+ type SimpleType string

+ func (i *SimpleType) UnmarshalJSON(data []byte) error

+ func (i SimpleType) MarshalJSON() ([]byte, error)

+ func (i SimpleType) ToSchemaOrBool() SchemaOrBool

+ func (i SimpleType) Type() Type

+ type ThenExposer interface

+ JSONSchemaThen func() interface{}

+ type Titled interface

+ Title func() string

+ type Type struct

+ SimpleTypes *SimpleType

+ SliceOfSimpleTypeValues []SimpleType

+ func (t *Type) UnmarshalJSON(data []byte) error

+ func (t *Type) WithSimpleTypes(val SimpleType) *Type

+ func (t *Type) WithSliceOfSimpleTypeValues(val ...SimpleType) *Type

+ func (t Type) MarshalJSON() ([]byte, error)