forked from openshift/origin
/
model_builder.go
277 lines (252 loc) · 7.33 KB
/
model_builder.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
package swagger
import (
"encoding/json"
"reflect"
"strings"
)
type modelBuilder struct {
Models map[string]Model
}
func (b modelBuilder) addModel(st reflect.Type, nameOverride string) {
modelName := b.keyFrom(st)
if nameOverride != "" {
modelName = nameOverride
}
// no models needed for primitive types
if b.isPrimitiveType(modelName) {
return
}
// see if we already have visited this model
if _, ok := b.Models[modelName]; ok {
return
}
sm := Model{
Id: modelName,
Required: []string{},
Properties: map[string]ModelProperty{}}
// reference the model before further initializing (enables recursive structs)
b.Models[modelName] = sm
// check for slice or array
if st.Kind() == reflect.Slice || st.Kind() == reflect.Array {
b.addModel(st.Elem(), "")
return
}
// check for structure or primitive type
if st.Kind() != reflect.Struct {
return
}
for i := 0; i < st.NumField(); i++ {
field := st.Field(i)
jsonName, prop := b.buildProperty(field, &sm, modelName)
if descTag := field.Tag.Get("description"); descTag != "" {
prop.Description = descTag
}
// add if not ommitted
if len(jsonName) != 0 {
// update Required
if b.isPropertyRequired(field) {
sm.Required = append(sm.Required, jsonName)
}
sm.Properties[jsonName] = prop
}
}
// update model builder with completed model
b.Models[modelName] = sm
}
func (b modelBuilder) isPropertyRequired(field reflect.StructField) bool {
required := true
if jsonTag := field.Tag.Get("json"); jsonTag != "" {
s := strings.Split(jsonTag, ",")
if len(s) > 1 && s[1] == "omitempty" {
return false
}
}
return required
}
func (b modelBuilder) buildProperty(field reflect.StructField, model *Model, modelName string) (jsonName string, prop ModelProperty) {
jsonName = b.jsonNameOfField(field)
if len(jsonName) == 0 {
// empty name signals skip property
return "", prop
}
fieldType := field.Type
fieldKind := fieldType.Kind()
if jsonTag := field.Tag.Get("json"); jsonTag != "" {
s := strings.Split(jsonTag, ",")
if len(s) > 1 && s[1] == "string" {
fieldType = reflect.TypeOf("")
}
}
var pType = b.jsonSchemaType(fieldType.String()) // may include pkg path
prop.Type = &pType
if b.isPrimitiveType(fieldType.String()) {
prop.Format = b.jsonSchemaFormat(fieldType.String())
return jsonName, prop
}
marshalerType := reflect.TypeOf((*json.Marshaler)(nil)).Elem()
if fieldType.Implements(marshalerType) {
var pType = "string"
prop.Type = &pType
return jsonName, prop
}
if fieldKind == reflect.Struct {
return b.buildStructTypeProperty(field, jsonName, model)
}
if fieldKind == reflect.Slice || fieldKind == reflect.Array {
return b.buildArrayTypeProperty(field, jsonName, modelName)
}
if fieldKind == reflect.Ptr {
return b.buildPointerTypeProperty(field, jsonName, modelName)
}
if fieldType.Name() == "" { // override type of anonymous structs
nestedTypeName := modelName + "." + jsonName
var pType = nestedTypeName
prop.Type = &pType
b.addModel(fieldType, nestedTypeName)
}
return jsonName, prop
}
func (b modelBuilder) buildStructTypeProperty(field reflect.StructField, jsonName string, model *Model) (nameJson string, prop ModelProperty) {
fieldType := field.Type
// check for anonymous
if len(fieldType.Name()) == 0 {
// anonymous
anonType := model.Id + "." + jsonName
b.addModel(fieldType, anonType)
prop.Type = &anonType
return jsonName, prop
}
if field.Name == fieldType.Name() && field.Anonymous {
// embedded struct
sub := modelBuilder{map[string]Model{}}
sub.addModel(fieldType, "")
subKey := sub.keyFrom(fieldType)
// merge properties from sub
subModel := sub.Models[subKey]
for k, v := range subModel.Properties {
model.Properties[k] = v
// if subModel says this property is required then include it
required := false
for _, each := range subModel.Required {
if k == each {
required = true
break
}
}
if required {
model.Required = append(model.Required, k)
}
}
// empty name signals skip property
return "", prop
}
// simple struct
b.addModel(fieldType, "")
var pType = fieldType.String()
prop.Type = &pType
return jsonName, prop
}
func (b modelBuilder) buildArrayTypeProperty(field reflect.StructField, jsonName, modelName string) (nameJson string, prop ModelProperty) {
fieldType := field.Type
var pType = "array"
prop.Type = &pType
elemName := b.getElementTypeName(modelName, jsonName, fieldType.Elem())
prop.Items = []Item{Item{Ref: &elemName}}
// add|overwrite model for element type
b.addModel(fieldType.Elem(), elemName)
return jsonName, prop
}
func (b modelBuilder) buildPointerTypeProperty(field reflect.StructField, jsonName, modelName string) (nameJson string, prop ModelProperty) {
fieldType := field.Type
// override type of pointer to list-likes
if fieldType.Elem().Kind() == reflect.Slice || fieldType.Elem().Kind() == reflect.Array {
var pType = "array"
prop.Type = &pType
elemName := b.getElementTypeName(modelName, jsonName, fieldType.Elem().Elem())
prop.Items = []Item{Item{Ref: &elemName}}
// add|overwrite model for element type
b.addModel(fieldType.Elem().Elem(), elemName)
} else {
// non-array, pointer type
var pType = fieldType.String()[1:] // no star, include pkg path
prop.Type = &pType
elemName := ""
if fieldType.Elem().Name() == "" {
elemName = modelName + "." + jsonName
prop.Type = &elemName
}
b.addModel(fieldType.Elem(), elemName)
}
return jsonName, prop
}
func (b modelBuilder) getElementTypeName(modelName, jsonName string, t reflect.Type) string {
if t.Name() == "" {
return modelName + "." + jsonName
}
if b.isPrimitiveType(t.Name()) {
return b.jsonSchemaType(t.Name())
}
return b.keyFrom(t)
}
func (b modelBuilder) keyFrom(st reflect.Type) string {
key := st.String()
if len(st.Name()) == 0 { // unnamed type
// Swagger UI has special meaning for [
key = strings.Replace(key, "[]", "||", -1)
}
return key
}
func (b modelBuilder) isPrimitiveType(modelName string) bool {
return strings.Contains("uint8 int int32 int64 float32 float64 bool string byte time.Time", modelName)
}
// jsonNameOfField returns the name of the field as it should appear in JSON format
// An empty string indicates that this field is not part of the JSON representation
func (b modelBuilder) jsonNameOfField(field reflect.StructField) string {
if jsonTag := field.Tag.Get("json"); jsonTag != "" {
s := strings.Split(jsonTag, ",")
if s[0] == "-" {
// empty name signals skip property
return ""
} else if s[0] != "" {
return s[0]
}
}
return field.Name
}
func (b modelBuilder) jsonSchemaType(modelName string) string {
schemaMap := map[string]string{
"uint8": "integer",
"int": "integer",
"int32": "integer",
"int64": "integer",
"byte": "string",
"float64": "number",
"float32": "number",
"bool": "boolean",
"time.Time": "string",
}
mapped, ok := schemaMap[modelName]
if ok {
return mapped
} else {
return modelName // use as is (custom or struct)
}
}
func (b modelBuilder) jsonSchemaFormat(modelName string) string {
schemaMap := map[string]string{
"int": "int32",
"int32": "int32",
"int64": "int64",
"byte": "byte",
"uint8": "byte",
"float64": "double",
"float32": "float",
"time.Time": "date-time",
}
mapped, ok := schemaMap[modelName]
if ok {
return mapped
} else {
return "" // no format
}
}