forked from go-swagno/swagno
-
Notifications
You must be signed in to change notification settings - Fork 0
/
generate.go
275 lines (256 loc) · 8.03 KB
/
generate.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
package swagno
import (
"encoding/json"
"fmt"
"log"
"reflect"
"strings"
)
// Generate swagger v2 documentation as json string
func (swagger Swagger) GenerateDocs() (jsonDocs []byte) {
if len(endpoints) == 0 {
log.Println("No endpoints found")
return
}
// generate defination object of swagger json: https://swagger.io/specification/v2/#definitions-object
generateSwaggerDefinition(&swagger, endpoints)
// convert all user EndPoint models to 'path' fields of swagger json
// https://swagger.io/specification/v2/#paths-object
for _, endpoint := range endpoints {
path := endpoint.Path
if swagger.Paths[path] == nil {
swagger.Paths[path] = make(map[string]swaggerEndpoint)
}
method := strings.ToLower(endpoint.Method)
consumes := []string{"application/json"}
produces := []string{"application/json", "application/xml"}
for _, param := range endpoint.Params {
if param.In == "formData" {
consumes = append([]string{"multipart/form-data"}, consumes...)
break
}
}
if len(endpoint.Consume) > 0 {
consumes = append(endpoint.Consume, consumes...)
}
if len(endpoint.Produce) > 0 {
produces = append(endpoint.Produce, produces...)
}
parameters := make([]swaggerParameter, 0)
for _, param := range endpoint.Params {
parameters = append(parameters, swaggerParameter{
Name: param.Name,
In: param.In,
Description: param.Description,
Required: param.Required,
Type: param.Type,
Format: param.Format,
Items: param.Items,
Enum: param.Enum,
Default: param.Default,
Min: param.Min,
Max: param.Max,
MinLen: param.MinLen,
MaxLen: param.MaxLen,
Pattern: param.Pattern,
MaxItems: param.MaxItems,
MinItems: param.MinItems,
UniqueItems: param.UniqueItems,
MultipleOf: param.MultipleOf,
CollenctionFormat: param.CollenctionFormat,
})
}
if endpoint.Body != nil {
bodySchema := swaggerResponseScheme{
Ref: fmt.Sprintf("#/definitions/%T", endpoint.Body),
}
if reflect.TypeOf(endpoint.Body).Kind() == reflect.Slice {
bodySchema = swaggerResponseScheme{
Type: "array",
Items: &swaggerResponseSchemeItems{
Ref: fmt.Sprintf("#/definitions/%T", endpoint.Body),
},
}
}
parameters = append(parameters, swaggerParameter{
Name: "body",
In: "body",
Description: "body",
Required: true,
Schema: &bodySchema,
})
}
var successSchema *swaggerResponseScheme
if endpoint.Return != nil {
successSchema = &swaggerResponseScheme{
Ref: fmt.Sprintf("#/definitions/%T", endpoint.Return),
}
if reflect.TypeOf(endpoint.Return).Kind() == reflect.Slice {
successSchema = &swaggerResponseScheme{
Type: "array",
Items: &swaggerResponseSchemeItems{
Ref: fmt.Sprintf("#/definitions/%T", endpoint.Return),
},
}
}
}
var errorSchema *swaggerResponseScheme
if endpoint.Error != nil {
errorSchema = &swaggerResponseScheme{
Ref: fmt.Sprintf("#/definitions/%T", endpoint.Error),
}
}
responses := make(map[string]swaggerResponse)
if successSchema != nil {
responses["200"] = swaggerResponse{
Description: "OK",
Schema: *successSchema,
}
}
if errorSchema != nil {
responses["404"] = swaggerResponse{
Description: "Not Found",
Schema: *errorSchema,
}
}
// add each endpoint to paths field of swagger
swagger.Paths[path][method] = swaggerEndpoint{
Description: endpoint.Description,
Summary: endpoint.Description,
OperationId: method + "-" + path,
Consumes: consumes,
Produces: produces,
Tags: endpoint.Tags,
Parameters: parameters,
Responses: responses,
Security: endpoint.Security,
}
}
// convert Swagger instance to json string and return it
json, err := json.MarshalIndent(swagger, "", " ")
if err != nil {
log.Println("Error while generating swagger json")
}
return json
}
// generate "definitions" keys from endpoints: https://swagger.io/specification/v2/#definitions-object
func generateSwaggerDefinition(swagger *Swagger, endpoints []Endpoint) {
// create all definations for each model used in endpoint
(*swagger).Definitions = make(map[string]swaggerDefinition)
for _, endpoint := range endpoints {
if endpoint.Body != nil {
createdefinition(swagger, endpoint.Body)
}
if endpoint.Return != nil {
createdefinition(swagger, endpoint.Return)
}
if endpoint.Error != nil {
createdefinition(swagger, endpoint.Error)
}
}
}
// generate "definitions" attribute for swagger json
func createdefinition(swagger *Swagger, t interface{}) {
reflectReturn := reflect.TypeOf(t)
if reflectReturn.Kind() == reflect.Slice {
reflectReturn = reflectReturn.Elem()
}
properties := make(map[string]swaggerDefinitionProperties)
for i := 0; i < reflectReturn.NumField(); i++ {
field := reflectReturn.Field(i)
fieldType := getType(field.Type.Kind().String())
// skip for function and channel types
if fieldType == "func" || fieldType == "chan" {
continue
}
// if item type is array, create defination for array element type
if fieldType == "array" {
if field.Type.Elem().Kind() == reflect.Struct {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Type: fieldType,
Items: &swaggerDefinitionPropertiesItems{
Ref: fmt.Sprintf("#/definitions/%s", field.Type.Elem().String()),
},
}
createdefinition(swagger, reflect.New(field.Type.Elem()).Elem().Interface())
} else {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Type: fieldType,
Items: &swaggerDefinitionPropertiesItems{
Type: getType(field.Type.Elem().Kind().String()),
},
}
}
} else {
if field.Type.Kind() == reflect.Struct {
if field.Type.String() == "time.Time" {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Type: "string",
Format: "date-time",
}
} else if field.Type.String() == "time.Duration" {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Type: "integer",
}
} else {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Ref: fmt.Sprintf("#/definitions/%s", field.Type.String()),
}
createdefinition(swagger, reflect.New(field.Type).Elem().Interface())
}
} else if field.Type.Kind() == reflect.Pointer {
if field.Type.Elem().Kind() == reflect.Struct {
if field.Type.Elem().String() == "time.Time" {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Type: "string",
Format: "date-time",
}
} else if field.Type.String() == "time.Duration" {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Type: "integer",
}
} else {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Ref: fmt.Sprintf("#/definitions/%s", field.Type.Elem().String()),
}
createdefinition(swagger, reflect.New(field.Type.Elem()).Elem().Interface())
}
} else {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Type: getType(field.Type.Elem().Kind().String()),
}
}
} else {
properties[getJsonTag(field)] = swaggerDefinitionProperties{
Type: fieldType,
}
}
}
}
(*swagger).Definitions[fmt.Sprintf("%T", t)] = swaggerDefinition{
Type: "object",
Properties: properties,
}
}
// get struct json tag as string of a struct field
func getJsonTag(field reflect.StructField) string {
jsonTag := field.Tag.Get("json")
if strings.Index(jsonTag, ",") > 0 {
return strings.Split(jsonTag, ",")[0]
}
return jsonTag
}
// get swagger type from reflection type
// https://swagger.io/specification/v2/#data-types
func getType(t string) string {
if strings.Contains(strings.ToLower(t), "int") {
return "integer"
} else if t == "array" || t == "slice" {
return "array"
} else if t == "bool" {
return "boolean"
} else if t == "float64" || t == "float32" {
return "number"
}
return t
}