/
generator.go
399 lines (348 loc) · 12.5 KB
/
generator.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
package autodoc
import (
"encoding/json"
"fmt"
"io"
"mime/multipart"
"net/http"
"net/url"
"reflect"
"github.com/labstack/echo"
"strings"
"time"
"runtime"
log "github.com/sirupsen/logrus"
)
var timeType = reflect.TypeOf(time.Time{})
// docGenerator 实现 echo.Context 接口,从而 hack 进业务逻辑代码(handler.go)中,详细见 collector.go
type docGenerator struct {
apiList []*api
}
var docGen = &docGenerator{}
func (dg *docGenerator) currentAPI() *api {
return dg.apiList[len(dg.apiList)-1]
}
func (dg *docGenerator) add(handlerName string, method string, path string) {
dg.apiList = append(dg.apiList, &api{handlerName: handlerName, method: method, path: path})
}
func (dg *docGenerator) generateMarkdown() string {
sb := stringBuilder{}
sb.WriteString(DefaultMarkdownHeader)
for _, api := range dg.apiList {
if WarningMissingFields {
api.warnMissingFields()
}
sb.WriteString(fmt.Sprintf("\n%s", api.String()))
}
sb.WriteString(DefaultMarkdownFooter)
return sb.String()
}
func (dg *docGenerator) Request() *http.Request { return nil }
func (dg *docGenerator) SetRequest(r *http.Request) {}
func (dg *docGenerator) Response() *echo.Response { return nil }
func (dg *docGenerator) IsTLS() bool { return false }
func (dg *docGenerator) IsWebSocket() bool { return false }
func (dg *docGenerator) Scheme() string { return "" }
func (dg *docGenerator) RealIP() string { return "" }
func (dg *docGenerator) Path() string { return "" }
func (dg *docGenerator) SetPath(p string) {}
func (dg *docGenerator) Param(name string) string { return "" }
func (dg *docGenerator) ParamNames() []string { return nil }
func (dg *docGenerator) SetParamNames(names ...string) {}
func (dg *docGenerator) ParamValues() []string { return nil }
func (dg *docGenerator) SetParamValues(values ...string) {}
func (dg *docGenerator) QueryParams() url.Values { return nil }
func (dg *docGenerator) QueryString() string { return "" }
func (dg *docGenerator) FormParams() (url.Values, error) { return nil, nil }
func (dg *docGenerator) MultipartForm() (*multipart.Form, error) { return nil, nil }
func (dg *docGenerator) SetCookie(cookie *http.Cookie) {}
func (dg *docGenerator) Cookies() []*http.Cookie { return nil }
func (dg *docGenerator) Set(key string, val interface{}) {}
func (dg *docGenerator) Validate(i interface{}) error { return nil }
func (dg *docGenerator) Render(code int, name string, data interface{}) error { return nil }
func (dg *docGenerator) HTML(code int, html string) error { return nil }
func (dg *docGenerator) HTMLBlob(code int, b []byte) error { return nil }
func (dg *docGenerator) JSONPretty(code int, i interface{}, indent string) error { return nil }
func (dg *docGenerator) JSONBlob(code int, b []byte) error { return nil }
func (dg *docGenerator) JSONP(code int, callback string, i interface{}) error { return nil }
func (dg *docGenerator) JSONPBlob(code int, callback string, b []byte) error { return nil }
func (dg *docGenerator) XML(code int, i interface{}) error { return nil }
func (dg *docGenerator) XMLPretty(code int, i interface{}, indent string) error { return nil }
func (dg *docGenerator) XMLBlob(code int, b []byte) error { return nil }
func (dg *docGenerator) Blob(code int, contentType string, b []byte) error { return nil }
func (dg *docGenerator) Stream(code int, contentType string, r io.Reader) error { return nil }
func (dg *docGenerator) File(file string) error { return nil }
func (dg *docGenerator) Attachment(file string, name string) error { return nil }
func (dg *docGenerator) Inline(file string, name string) error { return nil }
func (dg *docGenerator) Redirect(code int, url string) error { return nil }
func (dg *docGenerator) Error(err error) {}
func (dg *docGenerator) Handler() echo.HandlerFunc { return nil }
func (dg *docGenerator) SetHandler(h echo.HandlerFunc) {}
func (dg *docGenerator) Logger() echo.Logger { return nil }
func (dg *docGenerator) Echo() *echo.Echo { return nil }
func (dg *docGenerator) Reset(r *http.Request, w http.ResponseWriter) {}
func (dg *docGenerator) NoContent(code int) error {
if WarningWhenNotStatusOK && code != http.StatusOK {
log.Warnf("[c.NoContent] code is %d", code)
}
return nil
}
func (dg *docGenerator) String(code int, s string) error {
if WarningWhenNotStatusOK && code != http.StatusOK {
log.Warnf("[c.String] code is %d", code)
}
return nil
}
func (dg *docGenerator) Cookie(name string) (*http.Cookie, error) {
return &DefaultCookie, nil
}
// 显示在 README 中的类型
var validTypes = [...]string{"int", "float", "string", "bool"}
func (dg *docGenerator) isValidType(type_ string) bool {
for _, t := range validTypes {
if t == type_ {
return true
}
}
return false
}
// 类型, 描述
func (dg *docGenerator) parseTailComment(comment string, defaultType string) (type_ string, desc string) {
if comment == "" {
return "", ""
}
splits := strings.Split(comment, ",")
if len(splits) == 1 {
return defaultType, comment
}
type_ = strings.TrimSpace(splits[0])
if !dg.isValidType(type_) {
return defaultType, comment
}
return type_, strings.TrimSpace(strings.Join(splits[1:], ","))
}
// 暂时不加 parseTailComment
func (dg *docGenerator) Get(key string) interface{} {
if param, ok := customContextGetParams[key]; ok {
dg.currentAPI().addQueryParam(param)
}
if ret, ok := customContextGetReturnMap[key]; ok {
return ret
}
return DefaultGetReturn
}
func (dg *docGenerator) QueryParam(name string) string {
_, filePath, lineno, _ := runtime.Caller(1) // skip 的值取决于这行代码离要提取的注释相隔几层调用
comment := readTailComment(filePath, lineno)
if type_, desc := dg.parseTailComment(comment, "string"); desc != "" {
// 特殊大于全局
dg.currentAPI().addQueryParam(Param{type_, name, desc})
} else {
param, ok := customQueryParams[name]
if !ok {
param = Param{"string", name, ""}
}
dg.currentAPI().addQueryParam(param)
}
if ret, ok := customQueryParamReturnMap[name]; ok {
return ret
}
return DefaultQueryParamReturn
}
func (dg *docGenerator) FormFile(name string) (*multipart.FileHeader, error) {
_, filePath, lineno, _ := runtime.Caller(1) // skip 的值取决于这行代码离要提取的注释相隔几层调用
comment := readTailComment(filePath, lineno)
var param Param
if type_, desc := dg.parseTailComment(comment, "file"); desc != "" {
param = Param{type_, name, desc}
} else {
param = Param{"file", name, DefaultFormFileDesc}
}
dg.currentAPI().addFormParam(param)
return &DefaultMultipartFileHeader, nil
}
func (dg *docGenerator) FormValue(name string) string {
_, filePath, lineno, _ := runtime.Caller(1) // skip 的值取决于这行代码离要提取的注释相隔几层调用
comment := readTailComment(filePath, lineno)
if type_, desc := dg.parseTailComment(comment, "string"); desc != "" {
// 特殊大于全局
dg.currentAPI().addFormParam(Param{type_, name, desc})
} else {
param, ok := customFormParams[name]
if !ok {
param = Param{"string", name, ""}
}
dg.currentAPI().addFormParam(param)
}
if ret, ok := customFormValueReturnMap[name]; ok {
return ret
}
return DefaultFormValueReturn
}
func dereference(v reflect.Type) reflect.Type {
if v.Kind() == reflect.Ptr {
return v.Elem()
}
return v
}
func typeToString(type_ reflect.Type) string {
t := dereference(type_)
if jsonType, ok := customGoTypeToJSONType[type_.String()]; ok {
return jsonType
}
if jsonType, ok := customGoTypeToJSONType[type_.Name()]; ok {
return jsonType
}
switch t.Kind() {
case reflect.Invalid:
panic("[typeToString] 暂不支持 " + type_.String())
case reflect.Bool:
return "bool"
case reflect.Int,
reflect.Int8,
reflect.Int16,
reflect.Int32,
reflect.Int64,
reflect.Uint,
reflect.Uint8,
reflect.Uint16,
reflect.Uint32,
reflect.Uint64:
return "int"
case reflect.Float32,
reflect.Float64:
return "float"
case reflect.String:
return "string"
case reflect.Array,
reflect.Slice:
return typeToString(t.Elem()) + " array"
default:
return "object"
}
}
func getType(i interface{}) string {
return typeToString(reflect.TypeOf(i))
}
// struct / struct 指针 / struct slice / struct slice 指针
func parseStructWithPrefix(prefix string, structType reflect.Type) (params []Param) {
for structType.Kind() == reflect.Ptr || structType.Kind() == reflect.Slice {
structType = structType.Elem()
}
if structType.Kind() != reflect.Struct {
return params
}
// 提取 struct 内部信息
for i := 0; i < structType.NumField(); i++ {
field := structType.Field(i)
fieldType := dereference(field.Type)
jsonTag := field.Tag.Get("json")
if jsonTag == "-" {
continue
}
var name string
if jsonTag == "" {
// 不写 json tag 的话,就用属性类型代替
name = field.Name
} else {
name = strings.Split(jsonTag, ",")[0]
}
name = prefix + name
params = append(params, Param{typeToString(fieldType), name, field.Tag.Get("desc")})
// skip time.Time
if !fieldType.ConvertibleTo(timeType) {
switch fieldType.Kind() {
case reflect.Slice,
reflect.Ptr,
reflect.Struct:
params = append(params, parseStructWithPrefix(name+".", field.Type)...)
}
}
}
return params
}
// struct 或 struct 指针
func parseStruct(structType reflect.Type) []Param {
return parseStructWithPrefix("", structType)
}
func parseMap(mp map[string]interface{}) (params []Param) {
for name, val := range mp {
valType := dereference(reflect.TypeOf(val))
params = append(params, Param{typeToString(valType), name, ""})
// skip time.Time
if !valType.ConvertibleTo(timeType) {
switch valType.Kind() {
case reflect.Slice,
reflect.Ptr,
reflect.Struct:
params = append(params, parseStructWithPrefix(name+".", valType)...)
}
}
}
return params
}
func (dg *docGenerator) Bind(i interface{}) error {
// 传进来的一定是个 struct 指针
params := parseStruct(reflect.TypeOf(i).Elem())
for _, p := range params {
if customParam, ok := customPostJSONParams[p.Name]; ok {
p = customParam
}
dg.currentAPI().addJSONParam(p)
}
return nil
}
func (dg *docGenerator) JSON(code int, i interface{}) error {
defer ContextJSONer.AfterJSON(code, i)
ContextJSONer.BeforeJSON(code, i)
if WarningWhenNotStatusOK && code != http.StatusOK {
log.Warnf("[c.JSON] code is %d", code)
}
if FillZeroValue {
// TODO
//switch val := i.(type) {
//case map[string]interface{}:
// for _, _val := range val {
// valType := reflect.TypeOf(_val)
// // TODO: map中的,不是指针能修改吗?
// if valType.Kind() == reflect.Struct {
// FillStruct(&_val)
// } else if valType.Kind() == reflect.Ptr && valType.Elem().Kind() == reflect.Struct {
// FillStruct(_val)
// }
// }
//default:
// // 否则是个 struct 或 struct 指针
// valType := reflect.TypeOf(i)
// if valType.Kind() == reflect.Struct {
// FillStruct(&i)
// } else if valType.Kind() == reflect.Ptr && valType.Elem().Kind() == reflect.Struct {
// FillStruct(i)
// }
//}
}
data, err := json.MarshalIndent(i, "", "\t")
if err != nil {
panic(err)
}
dg.currentAPI().responseExampleJSON = string(data)
// TODO: 合并
var params []Param
switch val := i.(type) {
case map[string]interface{}:
params = parseMap(val)
default:
// 否则是个 struct 或 struct 指针
params = parseStruct(reflect.TypeOf(val))
}
for _, p := range params {
if _, ok := ignoredResponseJSONParams[p.Name]; ok {
continue
}
if customParam, ok := customResponseJSONParams[p.Name]; ok {
p = customParam
}
dg.currentAPI().addResponseParam(p)
}
return nil
}