forked from parvez3019/go-swagger3
/
param.go
200 lines (177 loc) · 7.19 KB
/
param.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
package operations
import (
"fmt"
"regexp"
"strings"
oas "github.com/Arlet2/go-swagger3/openApi3Schema"
"github.com/Arlet2/go-swagger3/parser/utils"
"github.com/iancoleman/orderedmap"
)
func (p *parser) parseParamComment(pkgPath, pkgName string, operation *oas.OperationObject, comment string) error {
// {name} {in} {goType} {required} {description} {example (optional)}
// user body User true "Info of a user."
// f file ignored true "Upload a file." "/home/arlet/go-swagger3/main.go"
re := regexp.MustCompile(`([-.\w]+)[\s]+([\w]+)[\s]+([\w./\[\]]+)[\s]+([\w]+)[\s]+"([^"]+)"([\s]+"([^"]+)")*`)
matches := re.FindStringSubmatch(comment)
if len(matches) != 8 && len(matches) != 6 {
return fmt.Errorf("parseParamComment can not parse param comment \"%s\"", comment)
}
parameterObject := oas.ParameterObject{}
appendName(¶meterObject, matches[1])
appendIn(¶meterObject, matches[2])
appendRequired(¶meterObject, matches[4])
appendDescription(¶meterObject, matches[5])
appendExample(¶meterObject, matches[7]) // 6 group is using for checking if example exist
goType := getType(re, matches)
// `file`, `form`
appendRequestBody(operation, parameterObject, goType)
// `path`, `query`, `header`, `cookie`
if parameterObject.In != "body" {
return p.appendQueryParam(pkgPath, pkgName, operation, parameterObject, goType)
}
return p.parseRequestBody(pkgPath, pkgName, operation, parameterObject, goType, matches)
}
func (p *parser) parseRequestBody(pkgPath string, pkgName string, operation *oas.OperationObject, parameterObject oas.ParameterObject, goType string, matches []string) error {
if operation.RequestBody == nil {
operation.RequestBody = &oas.RequestBodyObject{
Content: map[string]*oas.MediaTypeObject{},
Required: parameterObject.Required,
}
}
if strings.HasPrefix(goType, "[]") || strings.HasPrefix(goType, "map[]") || goType == "time.Time" {
return p.parseArrayMapOrTimeType(pkgPath, pkgName, operation, goType)
}
return p.parseGoBasicTypeOrStructType(pkgPath, pkgName, operation, matches)
}
func (p *parser) parseGoBasicTypeOrStructType(pkgPath string, pkgName string, operation *oas.OperationObject, matches []string) error {
typeName, err := p.RegisterType(pkgPath, pkgName, matches[3])
if err != nil {
return err
}
if utils.IsBasicGoType(typeName) {
operation.RequestBody.Content[oas.ContentTypeJson] = &oas.MediaTypeObject{Schema: oas.SchemaObject{Type: "string"}}
return nil
}
operation.RequestBody.Content[oas.ContentTypeJson] = &oas.MediaTypeObject{Schema: oas.SchemaObject{Ref: utils.AddSchemaRefLinkPrefix(typeName)}}
return nil
}
func (p *parser) parseArrayMapOrTimeType(pkgPath string, pkgName string, operation *oas.OperationObject, goType string) error {
parsedSchemaObject, err := p.ParseSchemaObject(pkgPath, pkgName, goType)
if err != nil {
p.Debug("parseResponseComment cannot parse goType", goType)
return err
}
if parsedSchemaObject != nil {
operation.RequestBody.Content[oas.ContentTypeJson] = &oas.MediaTypeObject{Schema: *parsedSchemaObject}
}
return nil
}
func (p *parser) appendQueryParam(pkgPath string, pkgName string, operation *oas.OperationObject, parameterObject oas.ParameterObject, goType string) error {
if parameterObject.In == "path" {
parameterObject.Required = true
}
if goType == "time.Time" {
return p.appendTimeParam(pkgPath, pkgName, operation, parameterObject, goType)
}
if utils.IsGoTypeOASType(goType) {
p.appendGoTypeParams(parameterObject, goType, operation)
}
if utils.IsEnumType(goType) {
p.appendEnumParamRef(goType, parameterObject, operation)
return nil
}
if strings.Contains(goType, "model.") {
return p.appendModelSchemaRef(pkgPath, pkgName, operation, parameterObject, goType)
}
return nil
}
func (p *parser) appendTimeParam(pkgPath string, pkgName string, operation *oas.OperationObject, parameterObject oas.ParameterObject, goType string) (err error) {
parameterObject.Schema, err = p.ParseSchemaObject(pkgPath, pkgName, goType)
if err != nil {
p.Debug("parseResponseComment cannot parse goType", goType)
}
operation.Parameters = append(operation.Parameters, parameterObject)
return err
}
func (p *parser) appendGoTypeParams(parameterObject oas.ParameterObject, goType string, operation *oas.OperationObject) {
parameterObject.Schema = &oas.SchemaObject{
Type: utils.GoTypesOASTypes[goType],
Format: utils.GoTypesOASFormats[goType],
Description: parameterObject.Description,
}
operation.Parameters = append(operation.Parameters, parameterObject)
}
func (p *parser) appendModelSchemaRef(pkgPath string, pkgName string, operation *oas.OperationObject, parameterObject oas.ParameterObject, goType string) error {
typeName, err := p.RegisterType(pkgPath, pkgName, goType)
if err != nil {
p.Debug("parse param model type failed", goType)
return err
}
parameterObject.Schema = &oas.SchemaObject{
Ref: utils.AddSchemaRefLinkPrefix(typeName),
Type: typeName,
}
operation.Parameters = append(operation.Parameters, parameterObject)
return nil
}
func (p *parser) appendEnumParamRef(goType string, parameterObject oas.ParameterObject, operation *oas.OperationObject) {
if strings.Contains(goType, "model.") {
goType = strings.Replace(goType, "model.", "", -1)
}
parameterObject.Schema = &oas.SchemaObject{Ref: utils.AddSchemaRefLinkPrefix(goType)}
operation.Parameters = append(operation.Parameters, parameterObject)
}
func appendRequestBody(operation *oas.OperationObject, parameterObject oas.ParameterObject, goType string) {
if !(parameterObject.In == "file" || parameterObject.In == "form") {
return
}
if operation.RequestBody == nil {
operation.RequestBody = &oas.RequestBodyObject{
Content: map[string]*oas.MediaTypeObject{
oas.ContentTypeForm: {Schema: oas.SchemaObject{Type: "object", Properties: orderedmap.New()}},
},
Required: parameterObject.Required,
}
}
if parameterObject.In == "file" {
operation.RequestBody.Content[oas.ContentTypeForm].Schema.Properties.Set(parameterObject.Name, &oas.SchemaObject{
Type: "string",
Format: "binary",
Description: parameterObject.Description,
})
}
if utils.IsGoTypeOASType(goType) {
operation.RequestBody.Content[oas.ContentTypeForm].Schema.Properties.Set(parameterObject.Name, &oas.SchemaObject{
Type: utils.GoTypesOASTypes[goType],
Format: utils.GoTypesOASFormats[goType],
Description: parameterObject.Description,
})
}
}
func getType(re *regexp.Regexp, matches []string) string {
re = regexp.MustCompile(`\[\w*\]`)
goType := re.ReplaceAllString(matches[3], "[]")
return goType
}
func appendRequired(paramObject *oas.ParameterObject, isRequired string) {
switch strings.ToLower(isRequired) {
case "true", "required":
paramObject.Required = true
}
}
func appendDescription(parameterObject *oas.ParameterObject, description string) {
parameterObject.Description = description
}
func appendIn(parameterObject *oas.ParameterObject, in string) {
parameterObject.In = in
}
func appendName(parameterObject *oas.ParameterObject, name string) {
parameterObject.Name = name
}
func appendExample(parameterObject *oas.ParameterObject, example string) {
if example == "" {
parameterObject.Example = nil
} else {
parameterObject.Example = example
}
}