forked from swaggo/swag
/
gen.go
457 lines (364 loc) · 11.5 KB
/
gen.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
package gen
import (
"bufio"
"bytes"
"encoding/json"
"fmt"
"go/format"
"io"
"log"
"os"
"path"
"path/filepath"
"strings"
"text/template"
"time"
"github.com/ghodss/yaml"
"github.com/go-openapi/spec"
"github.com/swaggo/swag"
)
var open = os.Open
// DefaultOverridesFile is the location swagger will look for type overrides.
const DefaultOverridesFile = ".swaggo"
type genTypeWriter func(*Config, *spec.Swagger) error
// Gen presents a generate tool for swag.
type Gen struct {
json func(data interface{}) ([]byte, error)
jsonIndent func(data interface{}) ([]byte, error)
jsonToYAML func(data []byte) ([]byte, error)
outputTypeMap map[string]genTypeWriter
}
// New creates a new Gen.
func New() *Gen {
gen := Gen{
json: json.Marshal,
jsonIndent: func(data interface{}) ([]byte, error) {
return json.MarshalIndent(data, "", " ")
},
jsonToYAML: yaml.JSONToYAML,
}
gen.outputTypeMap = map[string]genTypeWriter{
"go": gen.writeDocSwagger,
"json": gen.writeJSONSwagger,
"yaml": gen.writeYAMLSwagger,
"yml": gen.writeYAMLSwagger,
}
return &gen
}
// Config presents Gen configurations.
type Config struct {
Debugger swag.Debugger
// SearchDir the swag would parse,comma separated if multiple
SearchDir string
// excludes dirs and files in SearchDir,comma separated
Excludes string
// OutputDir represents the output directory for all the generated files
OutputDir string
// OutputTypes define types of files which should be generated
OutputTypes []string
// MainAPIFile the Go file path in which 'swagger general API Info' is written
MainAPIFile string
// PropNamingStrategy represents property naming strategy like snake case,camel case,pascal case
PropNamingStrategy string
// MarkdownFilesDir used to find markdown files, which can be used for tag descriptions
MarkdownFilesDir string
// CodeExampleFilesDir used to find code example files, which can be used for x-codeSamples
CodeExampleFilesDir string
// InstanceName is used to get distinct names for different swagger documents in the
// same project. The default value is "swagger".
InstanceName string
// ParseDepth dependency parse depth
ParseDepth int
// ParseVendor whether swag should be parse vendor folder
ParseVendor bool
// ParseDependencies whether swag should be parse outside dependency folder
ParseDependency bool
// ParseInternal whether swag should parse internal packages
ParseInternal bool
// Strict whether swag should error or warn when it detects cases which are most likely user errors
Strict bool
// GeneratedTime whether swag should generate the timestamp at the top of docs.go
GeneratedTime bool
// RequiredByDefault set validation required for all fields by default
RequiredByDefault bool
// OverridesFile defines global type overrides.
OverridesFile string
// ParseGoList whether swag use go list to parse dependency
ParseGoList bool
}
// Build builds swagger json file for given searchDir and mainAPIFile. Returns json.
func (g *Gen) Build(config *Config) error {
if config.InstanceName == "" {
config.InstanceName = swag.Name
}
searchDirs := strings.Split(config.SearchDir, ",")
for _, searchDir := range searchDirs {
if _, err := os.Stat(searchDir); os.IsNotExist(err) {
return fmt.Errorf("dir: %s does not exist", searchDir)
}
}
var overrides map[string]string
if config.OverridesFile != "" {
overridesFile, err := open(config.OverridesFile)
if err != nil {
// Don't bother reporting if the default file is missing; assume there are no overrides
if !(config.OverridesFile == DefaultOverridesFile && os.IsNotExist(err)) {
return fmt.Errorf("could not open overrides file: %w", err)
}
} else {
log.Printf("Using overrides from %s", config.OverridesFile)
overrides, err = parseOverrides(overridesFile)
if err != nil {
return err
}
}
}
log.Println("Generate swagger docs....")
p := swag.New(swag.SetMarkdownFileDirectory(config.MarkdownFilesDir),
swag.SetDebugger(config.Debugger),
swag.SetExcludedDirsAndFiles(config.Excludes),
swag.SetCodeExamplesDirectory(config.CodeExampleFilesDir),
swag.SetStrict(config.Strict),
swag.SetOverrides(overrides),
swag.ParseUsingGoList(config.ParseGoList),
)
p.PropNamingStrategy = config.PropNamingStrategy
p.ParseVendor = config.ParseVendor
p.ParseDependency = config.ParseDependency
p.ParseInternal = config.ParseInternal
p.RequiredByDefault = config.RequiredByDefault
if err := p.ParseAPIMultiSearchDir(searchDirs, config.MainAPIFile, config.ParseDepth); err != nil {
return err
}
swagger := p.GetSwagger()
if err := os.MkdirAll(config.OutputDir, os.ModePerm); err != nil {
return err
}
for _, outputType := range config.OutputTypes {
outputType = strings.ToLower(strings.TrimSpace(outputType))
if typeWriter, ok := g.outputTypeMap[outputType]; ok {
if err := typeWriter(config, swagger); err != nil {
return err
}
} else {
log.Printf("output type '%s' not supported", outputType)
}
}
return nil
}
func (g *Gen) writeDocSwagger(config *Config, swagger *spec.Swagger) error {
var filename = "docs.go"
if config.InstanceName != swag.Name {
filename = config.InstanceName + "_" + filename
}
docFileName := path.Join(config.OutputDir, filename)
absOutputDir, err := filepath.Abs(config.OutputDir)
if err != nil {
return err
}
packageName := filepath.Base(absOutputDir)
docs, err := os.Create(docFileName)
if err != nil {
return err
}
defer docs.Close()
// Write doc
err = g.writeGoDoc(packageName, docs, swagger, config)
if err != nil {
return err
}
log.Printf("create docs.go at %+v", docFileName)
return nil
}
func (g *Gen) writeJSONSwagger(config *Config, swagger *spec.Swagger) error {
var filename = "swagger.json"
if config.InstanceName != swag.Name {
filename = config.InstanceName + "_" + filename
}
jsonFileName := path.Join(config.OutputDir, filename)
b, err := g.jsonIndent(swagger)
if err != nil {
return err
}
err = g.writeFile(b, jsonFileName)
if err != nil {
return err
}
log.Printf("create swagger.json at %+v", jsonFileName)
return nil
}
func (g *Gen) writeYAMLSwagger(config *Config, swagger *spec.Swagger) error {
var filename = "swagger.yaml"
if config.InstanceName != swag.Name {
filename = config.InstanceName + "_" + filename
}
yamlFileName := path.Join(config.OutputDir, filename)
b, err := g.json(swagger)
if err != nil {
return err
}
y, err := g.jsonToYAML(b)
if err != nil {
return fmt.Errorf("cannot covert json to yaml error: %s", err)
}
err = g.writeFile(y, yamlFileName)
if err != nil {
return err
}
log.Printf("create swagger.yaml at %+v", yamlFileName)
return nil
}
func (g *Gen) writeFile(b []byte, file string) error {
f, err := os.Create(file)
if err != nil {
return err
}
defer f.Close()
_, err = f.Write(b)
return err
}
func (g *Gen) formatSource(src []byte) []byte {
code, err := format.Source(src)
if err != nil {
code = src // Formatter failed, return original code.
}
return code
}
// Read and parse the overrides file.
func parseOverrides(r io.Reader) (map[string]string, error) {
overrides := make(map[string]string)
scanner := bufio.NewScanner(r)
for scanner.Scan() {
line := scanner.Text()
// Skip comments
if len(line) > 1 && line[0:2] == "//" {
continue
}
parts := strings.Fields(line)
switch len(parts) {
case 0:
// only whitespace
continue
case 2:
// either a skip or malformed
if parts[0] != "skip" {
return nil, fmt.Errorf("could not parse override: '%s'", line)
}
overrides[parts[1]] = ""
case 3:
// either a replace or malformed
if parts[0] != "replace" {
return nil, fmt.Errorf("could not parse override: '%s'", line)
}
overrides[parts[1]] = parts[2]
default:
return nil, fmt.Errorf("could not parse override: '%s'", line)
}
}
if err := scanner.Err(); err != nil {
return nil, fmt.Errorf("error reading overrides file: %w", err)
}
return overrides, nil
}
func (g *Gen) writeGoDoc(packageName string, output io.Writer, swagger *spec.Swagger, config *Config) error {
generator, err := template.New("swagger_info").Funcs(template.FuncMap{
"printDoc": func(v string) string {
// Add schemes
v = "{\n \"schemes\": {{ marshal .Schemes }}," + v[1:]
// Sanitize backticks
return strings.Replace(v, "`", "`+\"`\"+`", -1)
},
}).Parse(packageTemplate)
if err != nil {
return err
}
swaggerSpec := &spec.Swagger{
VendorExtensible: swagger.VendorExtensible,
SwaggerProps: spec.SwaggerProps{
ID: swagger.ID,
Consumes: swagger.Consumes,
Produces: swagger.Produces,
Swagger: swagger.Swagger,
Info: &spec.Info{
VendorExtensible: swagger.Info.VendorExtensible,
InfoProps: spec.InfoProps{
Description: "{{escape .Description}}",
Title: "{{.Title}}",
TermsOfService: swagger.Info.TermsOfService,
Contact: swagger.Info.Contact,
License: swagger.Info.License,
Version: "{{.Version}}",
},
},
Host: "{{.Host}}",
BasePath: "{{.BasePath}}",
Paths: swagger.Paths,
Definitions: swagger.Definitions,
Parameters: swagger.Parameters,
Responses: swagger.Responses,
SecurityDefinitions: swagger.SecurityDefinitions,
Security: swagger.Security,
Tags: swagger.Tags,
ExternalDocs: swagger.ExternalDocs,
},
}
// crafted docs.json
buf, err := g.jsonIndent(swaggerSpec)
if err != nil {
return err
}
buffer := &bytes.Buffer{}
err = generator.Execute(buffer, struct {
Timestamp time.Time
Doc string
Host string
PackageName string
BasePath string
Title string
Description string
Version string
InstanceName string
Schemes []string
GeneratedTime bool
}{
Timestamp: time.Now(),
GeneratedTime: config.GeneratedTime,
Doc: string(buf),
Host: swagger.Host,
PackageName: packageName,
BasePath: swagger.BasePath,
Schemes: swagger.Schemes,
Title: swagger.Info.Title,
Description: swagger.Info.Description,
Version: swagger.Info.Version,
InstanceName: config.InstanceName,
})
if err != nil {
return err
}
code := g.formatSource(buffer.Bytes())
// write
_, err = output.Write(code)
return err
}
var packageTemplate = `// Package {{.PackageName}} GENERATED BY SWAG; DO NOT EDIT
// This file was generated by swaggo/swag{{ if .GeneratedTime }} at
// {{ .Timestamp }}{{ end }}
package {{.PackageName}}
import "github.com/swaggo/swag"
const docTemplate{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }} = ` + "`{{ printDoc .Doc}}`" + `
// SwaggerInfo{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }} holds exported Swagger Info so clients can modify it
var SwaggerInfo{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }} = &swag.Spec{
Version: {{ printf "%q" .Version}},
Host: {{ printf "%q" .Host}},
BasePath: {{ printf "%q" .BasePath}},
Schemes: []string{ {{ range $index, $schema := .Schemes}}{{if gt $index 0}},{{end}}{{printf "%q" $schema}}{{end}} },
Title: {{ printf "%q" .Title}},
Description: {{ printf "%q" .Description}},
InfoInstanceName: {{ printf "%q" .InstanceName }},
SwaggerTemplate: docTemplate{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }},
}
func init() {
swag.Register(SwaggerInfo{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }}.InstanceName(), SwaggerInfo{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }})
}
`