forked from alecthomas/jsonschema
-
Notifications
You must be signed in to change notification settings - Fork 3
/
reflect.go
584 lines (519 loc) · 18.1 KB
/
reflect.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
// Package jsonschema uses reflection to generate JSON Schemas from Go types [1].
//
// If json tags are present on struct fields, they will be used to infer
// property names and if a property is required (omitempty is present).
//
// [1] http://json-schema.org/latest/json-schema-validation.html
package jsonschema
import (
"encoding/json"
"net"
"net/url"
"reflect"
"strconv"
"strings"
"time"
)
// Version is the JSON Schema version.
// If extending JSON Schema with custom values use a custom URI.
// RFC draft-wright-json-schema-00, section 6
var Version = "http://json-schema.org/draft-07/schema#"
// Schema is the root schema.
// RFC draft-wright-json-schema-00, section 4.5
type Schema struct {
*Type
Definitions Definitions `json:"definitions,omitempty"`
}
// Type represents a JSON Schema object type.
type Type struct {
// RFC draft-wright-json-schema-00
Version string `json:"$schema,omitempty"` // section 6.1
Ref string `json:"$ref,omitempty"` // section 7
// RFC draft-wright-json-schema-validation-00, section 5
MultipleOf int `json:"multipleOf,omitempty"` // section 5.1
Maximum int `json:"maximum,omitempty"` // section 5.2
ExclusiveMaximum int `json:"exclusiveMaximum,omitempty"` // section 5.3
Minimum int `json:"minimum,omitempty"` // section 5.4
ExclusiveMinimum int `json:"exclusiveMinimum,omitempty"` // section 5.5
MaxLength int `json:"maxLength,omitempty"` // section 5.6
MinLength int `json:"minLength,omitempty"` // section 5.7
Pattern string `json:"pattern,omitempty"` // section 5.8
AdditionalItems *Type `json:"additionalItems,omitempty"` // section 5.9
Items *Type `json:"items,omitempty"` // section 5.9
MaxItems int `json:"maxItems,omitempty"` // section 5.10
MinItems int `json:"minItems,omitempty"` // section 5.11
UniqueItems bool `json:"uniqueItems,omitempty"` // section 5.12
MaxProperties int `json:"maxProperties,omitempty"` // section 5.13
MinProperties int `json:"minProperties,omitempty"` // section 5.14
Required []string `json:"required,omitempty"` // section 5.15
Properties map[string]*Type `json:"properties,omitempty"` // section 5.16
PatternProperties map[string]*Type `json:"patternProperties,omitempty"` // section 5.17
AdditionalProperties json.RawMessage `json:"additionalProperties,omitempty"` // section 5.18
Dependencies map[string]*Type `json:"dependencies,omitempty"` // section 5.19
Enum []interface{} `json:"enum,omitempty"` // section 5.20
Type string `json:"type,omitempty"` // section 5.21
AllOf []*Type `json:"allOf,omitempty"` // section 5.22
AnyOf []*Type `json:"anyOf,omitempty"` // section 5.23
OneOf []*Type `json:"oneOf,omitempty"` // section 5.24
If *Type `json:"if,omitempty"`
Then *Type `json:"then,omitempty"`
Else *Type `json:"else,omitempty"`
Not *Type `json:"not,omitempty"` // section 5.25
Definitions Definitions `json:"definitions,omitempty"` // section 5.26
// RFC draft-wright-json-schema-validation-00, section 6, 7
Title string `json:"title,omitempty"` // section 6.1
Description string `json:"description,omitempty"` // section 6.1
Default interface{} `json:"default,omitempty"` // section 6.2
Format string `json:"format,omitempty"` // section 7
// RFC draft-wright-json-schema-hyperschema-00, section 4
Media *Type `json:"media,omitempty"` // section 4.3
BinaryEncoding string `json:"binaryEncoding,omitempty"` // section 4.3
// Precedence of Parent struct tag over embedded field tags
tagPrecedence map[string]reflect.StructTag
}
// StructOrder : to define the order of the of the structure where the root struct should br processed first then
// the other embedded structs
type structOrder struct {
st *Type
definitions Definitions
ft reflect.Type
}
// Reflect reflects to Schema from a value using the default Reflector
func Reflect(v interface{}) *Schema {
return ReflectFromType(reflect.TypeOf(v))
}
// ReflectFromType generates root schema using the default Reflector
func ReflectFromType(t reflect.Type) *Schema {
r := &Reflector{}
return r.ReflectFromType(t)
}
// A Reflector reflects values into a Schema.
type Reflector struct {
// AllowAdditionalProperties will cause the Reflector to generate a schema
// with additionalProperties to 'true' for all struct types. This means
// the presence of additional keys in JSON objects will not cause validation
// to fail. Note said additional keys will simply be dropped when the
// validated JSON is unmarshaled.
AllowAdditionalProperties bool
// RequiredFromJSONSchemaTags will cause the Reflector to generate a schema
// that requires any key tagged with `jsonschema:required`, overriding the
// default of requiring any key *not* tagged with `json:,omitempty`.
RequiredFromJSONSchemaTags bool
// ExpandedStruct will cause the toplevel definitions of the schema not
// be referenced itself to a definition.
ExpandedStruct bool
// Overrides is of interface SchemaTagOverride and will be used to override any jsonschema tags on existing fields
// The expected use case is for shared nested structs where validation is stricter on certain fields
// For example a shared nested struct with field `Species` and tag `enum=Human|Dog|Alien` may be used by
// applications that want to declare a stricter tag `required,enum=Dog`
Overrides SchemaTagOverride
}
// Reflect reflects to Schema from a value.
func (r *Reflector) Reflect(v interface{}) *Schema {
return r.ReflectFromType(reflect.TypeOf(v))
}
// ReflectFromType generates root schema
func (r *Reflector) ReflectFromType(t reflect.Type) *Schema {
definitions := Definitions{}
if r.ExpandedStruct {
st := &Type{
Version: Version,
Type: "object",
Properties: map[string]*Type{},
AdditionalProperties: bool2bytes(r.AllowAdditionalProperties),
tagPrecedence: map[string]reflect.StructTag{},
}
r.reflectStructFields(st, definitions, t)
r.reflectStruct(definitions, t)
delete(definitions, t.Name())
return &Schema{Type: st, Definitions: definitions}
}
rootType := r.reflectTypeToSchema(definitions, t)
rootType.Version = Version
s := &Schema{
Type: rootType,
Definitions: definitions,
}
return s
}
// Definitions hold schema definitions.
// http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.26
// RFC draft-wright-json-schema-validation-00, section 5.26
type Definitions map[string]*Type
// Available Go defined types for JSON Schema Validation.
// RFC draft-wright-json-schema-validation-00, section 7.3
var (
timeType = reflect.TypeOf(time.Time{}) // date-time RFC section 7.3.1
ipType = reflect.TypeOf(net.IP{}) // ipv4 and ipv6 RFC section 7.3.4, 7.3.5
uriType = reflect.TypeOf(url.URL{}) // uri RFC section 7.3.6
)
// Byte slices will be encoded as base64
var byteSliceType = reflect.TypeOf([]byte(nil))
// Go code generated from protobuf enum types should fulfil this interface.
type protoEnum interface {
EnumDescriptor() ([]byte, []int)
}
type minItems interface {
MinItems() int
}
type maxItems interface {
MaxItems() int
}
var protoEnumType = reflect.TypeOf((*protoEnum)(nil)).Elem()
var minItemsType = reflect.TypeOf((*minItems)(nil)).Elem()
var maxItemsType = reflect.TypeOf((*maxItems)(nil)).Elem()
func (r *Reflector) reflectTypeToSchema(definitions Definitions, t reflect.Type) (schema *Type) {
// Already added to definitions?
definitionsKey := getDefinitionKeyFromType(t)
if _, ok := definitions[definitionsKey]; ok {
return &Type{Ref: "#/definitions/" + definitionsKey}
}
// jsonpb will marshal protobuf enum options as either strings or integers.
// It will unmarshal either.
if t.Implements(protoEnumType) {
return &Type{OneOf: []*Type{
{Type: "string"},
{Type: "integer"},
}}
}
// Defined format types for JSON Schema Validation
// RFC draft-wright-json-schema-validation-00, section 7.3
// TODO email RFC section 7.3.2, hostname RFC section 7.3.3, uriref RFC section 7.3.7
switch t {
case ipType:
// TODO differentiate ipv4 and ipv6 RFC section 7.3.4, 7.3.5
return &Type{Type: "string", Format: "ipv4"} // ipv4 RFC section 7.3.4
}
switch t.Kind() {
case reflect.Struct:
switch t {
case timeType: // date-time RFC section 7.3.1
return &Type{Type: "string", Format: "date-time"}
case uriType: // uri RFC section 7.3.6
return &Type{Type: "string", Format: "uri"}
default:
return r.reflectStruct(definitions, t)
}
case reflect.Map:
rt := &Type{
Type: "object",
PatternProperties: nil,
}
// map[...]interface{} should allow any child type. If another value type is specified,
// It should be added to the object properties spec.
if t.Elem().Kind() != reflect.Interface {
rt.PatternProperties = map[string]*Type{
".*": r.reflectTypeToSchema(definitions, t.Elem()),
}
delete(rt.PatternProperties, "additionalProperties")
}
return rt
case reflect.Slice, reflect.Array:
// encoding/json.RawMessage is an alias for a bytes slice but need to be handled like a map
if t.Name() == "RawMessage" && t.PkgPath() == "encoding/json" {
rt := &Type{
Type: "object",
PatternProperties: nil,
}
return rt
}
returnType := &Type{}
if t.Kind() == reflect.Array {
returnType.MinItems = t.Len()
returnType.MaxItems = returnType.MinItems
}
if t.Kind() == reflect.Slice && t != byteSliceType && t.Implements(minItemsType) {
returnType.MinItems = reflect.New(t).Interface().(minItems).MinItems()
}
if t.Kind() == reflect.Slice && t != byteSliceType && t.Implements(maxItemsType) {
returnType.MaxItems = reflect.New(t).Interface().(maxItems).MaxItems()
}
switch t {
case byteSliceType:
returnType.Type = "string"
returnType.Media = &Type{BinaryEncoding: "base64"}
return returnType
default:
returnType.Type = "array"
returnType.Items = r.reflectTypeToSchema(definitions, t.Elem())
return returnType
}
case reflect.Interface:
return &Type{
Type: "object",
AdditionalProperties: []byte("true"),
}
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64,
reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
return &Type{Type: "integer"}
case reflect.Float32, reflect.Float64:
return &Type{Type: "number"}
case reflect.Bool:
return &Type{Type: "boolean"}
case reflect.String:
return &Type{Type: "string"}
case reflect.Ptr:
return r.reflectTypeToSchema(definitions, t.Elem())
}
panic("unsupported type " + t.String())
}
// Refects a struct to a JSON Schema type.
func (r *Reflector) reflectStruct(definitions Definitions, t reflect.Type) *Type {
// When OneOf/AnyOf/AllOf interfaces are implemented, we will not process any rules from the struct that implements it
// jsonschema will be generated for only what is returned in []reflect.StructField
if schema := r.getExclusiveSubschemaForBooleanCases(definitions, t); schema != nil {
return schema
}
st := &Type{
Type: "object",
Properties: map[string]*Type{},
AdditionalProperties: bool2bytes(r.AllowAdditionalProperties),
tagPrecedence: map[string]reflect.StructTag{},
}
definitionsKey := getDefinitionKeyFromType(t)
definitions[definitionsKey] = st
r.reflectStructFields(st, definitions, t)
r.addSubschemasForConditionalCases(st, definitions, t)
return &Type{Ref: "#/definitions/" + definitionsKey}
}
func (r *Reflector) reflectStructFields(st *Type, definitions Definitions, t reflect.Type) {
t = getNonPointerType(t)
// orderArray to determine the order of the reflection for the struct
orderArray := []structOrder{}
for i := 0; i < t.NumField(); i++ {
f := t.Field(i)
// Prevent duplicate jsonschema name declarations when using embeds
name, required := r.reflectFieldName(f, t)
if !f.Anonymous {
_, ok := st.tagPrecedence[name]
if !ok {
st.tagPrecedence[name] = f.Tag
} else {
f.Tag = st.tagPrecedence[name]
}
}
// anonymous and exported type should be processed recursively
// current type should inherit properties of anonymous one
if f.Anonymous && f.PkgPath == "" {
structOrder := structOrder{st: st, definitions: definitions, ft: f.Type}
// inserting into the orderArray the current struct
orderArray = append(orderArray, structOrder)
continue
}
if name == "" {
continue
}
property := r.reflectTypeToSchema(definitions, f.Type)
property.structKeywordsFromTags(r.getJSONSchemaTags(f, t))
st.Properties[name] = property
if required {
// Boolean Value to indicate if element is already present
isPresent := false
for index := range st.Required {
if name == st.Required[index] {
isPresent = true
}
}
if !isPresent {
st.Required = append(st.Required, name)
}
}
}
// Processing recursively the struct for reflection of struct elements
for _, eachStruct := range orderArray {
r.reflectStructFields(eachStruct.st, eachStruct.definitions, eachStruct.ft)
eachStruct.st.tagPrecedence = map[string]reflect.StructTag{}
}
r.addSubschemasForBooleanCases(st, definitions, t)
r.addSubschemasForSwitch(st, definitions, t)
}
func (t *Type) structKeywordsFromTags(tags []string) {
switch t.Type {
case "string":
t.stringKeywords(tags)
case "number":
t.floatKeywords(tags)
case "integer":
t.numbericKeywords(tags)
case "array":
t.arrayKeywords(tags)
case "":
t.stringKeywords(tags)
}
}
// read struct tags for string type keywords
func (t *Type) stringKeywords(tags []string) {
for _, tag := range tags {
nameValue := strings.Split(tag, "=")
if len(nameValue) == 2 {
name, val := nameValue[0], nameValue[1]
switch name {
case "minLength":
i, _ := strconv.Atoi(val)
t.MinLength = i
case "maxLength":
i, _ := strconv.Atoi(val)
t.MaxLength = i
case "enum":
enum := strings.Split(val, "|")
s := make([]interface{}, len(enum))
for k, v := range enum {
s[k] = v
}
t.Enum = s
case "format":
switch val {
case "date-time", "email", "hostname", "ipv4", "ipv6", "uri":
t.Format = val
break
}
case "pattern":
t.Pattern = val
}
} else {
name := nameValue[0]
switch name {
case "notEmpty":
t.Pattern = "^\\S"
case "allowNull":
t.OneOf = []*Type{
{Type: t.Type},
{Type: "null"},
}
t.Type = ""
}
}
}
}
// read struct tags for numberic type keywords
func (t *Type) numbericKeywords(tags []string) {
for _, tag := range tags {
nameValue := strings.Split(tag, "=")
if len(nameValue) == 2 {
name, val := nameValue[0], nameValue[1]
switch name {
case "multipleOf":
i, _ := strconv.Atoi(val)
t.MultipleOf = i
case "minimum":
i, _ := strconv.Atoi(val)
t.Minimum = i
case "maximum":
i, _ := strconv.Atoi(val)
t.Maximum = i
case "exclusiveMaximum":
b, _ := strconv.Atoi(val)
t.ExclusiveMaximum = b
case "exclusiveMinimum":
b, _ := strconv.Atoi(val)
t.ExclusiveMinimum = b
case "enum":
enum := strings.Split(val, "|")
s := make([]interface{}, len(enum))
for k, v := range enum {
s[k], _ = strconv.Atoi(v)
}
t.Enum = s
}
} else {
name := nameValue[0]
switch name {
case "allowNull":
t.OneOf = []*Type{
{Type: t.Type},
{Type: "null"},
}
t.Type = ""
}
}
}
}
// read struct tags for float type keywords
func (t *Type) floatKeywords(tags []string) {
for _, tag := range tags {
nameValue := strings.Split(tag, "=")
if len(nameValue) == 2 {
name, val := nameValue[0], nameValue[1]
switch name {
case "enum":
enum := strings.Split(val, "|")
s := make([]interface{}, len(enum))
for k, v := range enum {
s[k], _ = strconv.ParseFloat(v, 64)
}
t.Enum = s
}
} else {
name := nameValue[0]
switch name {
case "allowNull":
t.OneOf = []*Type{
{Type: t.Type},
{Type: "null"},
}
t.Type = ""
}
}
}
}
// read struct tags for array type keywods
func (t *Type) arrayKeywords(tags []string) {
for _, tag := range tags {
nameValue := strings.Split(tag, "=")
if len(nameValue) == 2 {
name, val := nameValue[0], nameValue[1]
switch name {
case "minItems":
i, _ := strconv.Atoi(val)
t.MinItems = i
case "maxItems":
i, _ := strconv.Atoi(val)
t.MaxItems = i
case "uniqueItems":
t.UniqueItems = true
}
} else {
name := nameValue[0]
switch name {
case "allowNull":
t.OneOf = []*Type{
{Type: t.Type},
{Type: "null"},
}
t.Type = ""
}
}
}
}
func (r *Reflector) reflectFieldName(f reflect.StructField, t reflect.Type) (string, bool) {
if f.PkgPath != "" { // unexported field, ignore it
return "", false
}
jsonTags := strings.Split(f.Tag.Get("json"), ",")
if ignoredByJSONTags(jsonTags) {
return "", false
}
jsonSchemaTags := r.getJSONSchemaTags(f, t)
if ignoredByJSONSchemaTags(jsonSchemaTags) {
return "", false
}
name := f.Name
required := requiredFromJSONTags(jsonTags)
if r.RequiredFromJSONSchemaTags {
required = requiredFromJSONSchemaTags(jsonSchemaTags)
}
required = remainsRequiredFromJSONSchemaTags(jsonSchemaTags, required)
if jsonTags[0] != "" {
name = jsonTags[0]
}
return name, required
}
func (r *Reflector) getJSONSchemaTags(f reflect.StructField, t reflect.Type) []string {
tag := f.Tag.Get("jsonschema")
if r.Overrides != nil && t != nil {
if tagOverride := r.Overrides.Get(t, f.Name); tagOverride != "" {
tag = tagOverride
}
}
return strings.Split(tag, ",")
}