forked from go-kratos/kratos
-
Notifications
You must be signed in to change notification settings - Fork 0
/
generator.go
341 lines (321 loc) · 10.1 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
package main
import (
"encoding/json"
"net/http"
"reflect"
"regexp"
"strings"
"github.com/go-kratos/kratos/tool/protobuf/pkg/gen"
"github.com/go-kratos/kratos/tool/protobuf/pkg/generator"
"github.com/go-kratos/kratos/tool/protobuf/pkg/naming"
"github.com/go-kratos/kratos/tool/protobuf/pkg/tag"
"github.com/go-kratos/kratos/tool/protobuf/pkg/typemap"
"github.com/golang/protobuf/protoc-gen-go/descriptor"
plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
)
type swaggerGen struct {
generator.Base
// defsMap will fill into swagger's definitions
// key is full qualified proto name
defsMap map[string]*typemap.MessageDefinition
}
// NewSwaggerGenerator a swagger generator
func NewSwaggerGenerator() *swaggerGen {
return &swaggerGen{}
}
func (t *swaggerGen) Generate(in *plugin.CodeGeneratorRequest) *plugin.CodeGeneratorResponse {
t.Setup(in)
resp := &plugin.CodeGeneratorResponse{}
for _, f := range t.GenFiles {
if len(f.Service) == 0 {
continue
}
respFile := t.generateSwagger(f)
if respFile != nil {
resp.File = append(resp.File, respFile)
}
}
return resp
}
func (t *swaggerGen) generateSwagger(file *descriptor.FileDescriptorProto) *plugin.CodeGeneratorResponse_File {
var pkg = file.GetPackage()
r := regexp.MustCompile("v(\\d+)$")
strs := r.FindStringSubmatch(pkg)
var vStr string
if len(strs) >= 2 {
vStr = strs[1]
} else {
vStr = ""
}
var swaggerObj = &swaggerObject{
Paths: swaggerPathsObject{},
Swagger: "2.0",
Info: swaggerInfoObject{
Title: file.GetName(),
Version: vStr,
},
Schemes: []string{"http", "https"},
Consumes: []string{"application/json", "multipart/form-data"},
Produces: []string{"application/json"},
}
t.defsMap = map[string]*typemap.MessageDefinition{}
out := &plugin.CodeGeneratorResponse_File{}
name := naming.GenFileName(file, ".swagger.json")
for _, svc := range file.Service {
for _, meth := range svc.Method {
if !t.ShouldGenForMethod(file, svc, meth) {
continue
}
apiInfo := t.GetHttpInfoCached(file, svc, meth)
pathItem := swaggerPathItemObject{}
if originPathItem, ok := swaggerObj.Paths[apiInfo.Path]; ok {
pathItem = originPathItem
}
op := t.getOperationByHTTPMethod(apiInfo.HttpMethod, &pathItem)
op.Summary = apiInfo.Title
op.Description = apiInfo.Description
swaggerObj.Paths[apiInfo.Path] = pathItem
op.Tags = []string{pkg + "." + svc.GetName()}
// request
request := t.Reg.MessageDefinition(meth.GetInputType())
// request cannot represent by simple form
isComplexRequest := false
for _, field := range request.Descriptor.Field {
if !generator.IsScalar(field) {
isComplexRequest = true
break
}
}
if !isComplexRequest && apiInfo.HttpMethod == "GET" {
for _, field := range request.Descriptor.Field {
if !generator.IsScalar(field) {
continue
}
p := t.getQueryParameter(file, request, field)
op.Parameters = append(op.Parameters, p)
}
} else {
p := swaggerParameterObject{}
p.In = "body"
p.Required = true
p.Name = "body"
p.Schema = &swaggerSchemaObject{}
p.Schema.Ref = "#/definitions/" + meth.GetInputType()
op.Parameters = []swaggerParameterObject{p}
}
// response
resp := swaggerResponseObject{}
resp.Description = "A successful response."
// proto 里面的response只定义data里面的
// 所以需要把code msg data 这一级加上
resp.Schema.Type = "object"
resp.Schema.Properties = &swaggerSchemaObjectProperties{}
p := keyVal{Key: "code", Value: &schemaCore{Type: "integer"}}
*resp.Schema.Properties = append(*resp.Schema.Properties, p)
p = keyVal{Key: "message", Value: &schemaCore{Type: "string"}}
*resp.Schema.Properties = append(*resp.Schema.Properties, p)
p = keyVal{Key: "data", Value: schemaCore{Ref: "#/definitions/" + meth.GetOutputType()}}
*resp.Schema.Properties = append(*resp.Schema.Properties, p)
op.Responses = swaggerResponsesObject{"200": resp}
}
}
// walk though definitions
t.walkThroughFileDefinition(file)
defs := swaggerDefinitionsObject{}
swaggerObj.Definitions = defs
for typ, msg := range t.defsMap {
def := swaggerSchemaObject{}
def.Properties = new(swaggerSchemaObjectProperties)
def.Description = strings.Trim(msg.Comments.Leading, "\n\r ")
for _, field := range msg.Descriptor.Field {
p := keyVal{Key: generator.GetFormOrJSONName(field)}
schema := t.schemaForField(file, msg, field)
if generator.GetFieldRequired(field, t.Reg, msg) {
def.Required = append(def.Required, p.Key)
}
p.Value = schema
*def.Properties = append(*def.Properties, p)
}
def.Type = "object"
defs[typ] = def
}
b, _ := json.MarshalIndent(swaggerObj, "", " ")
str := string(b)
out.Name = &name
out.Content = &str
return out
}
func (t *swaggerGen) getOperationByHTTPMethod(httpMethod string, pathItem *swaggerPathItemObject) *swaggerOperationObject {
var op = &swaggerOperationObject{}
switch httpMethod {
case http.MethodGet:
pathItem.Get = op
case http.MethodPost:
pathItem.Post = op
case http.MethodPut:
pathItem.Put = op
case http.MethodDelete:
pathItem.Delete = op
case http.MethodPatch:
pathItem.Patch = op
default:
pathItem.Get = op
}
return op
}
func (t *swaggerGen) getQueryParameter(file *descriptor.FileDescriptorProto,
input *typemap.MessageDefinition,
field *descriptor.FieldDescriptorProto) swaggerParameterObject {
p := swaggerParameterObject{}
p.Name = generator.GetFormOrJSONName(field)
fComment, _ := t.Reg.FieldComments(input, field)
cleanComment := tag.GetCommentWithoutTag(fComment.Leading)
p.Description = strings.Trim(strings.Join(cleanComment, "\n"), "\n\r ")
validateComment := getValidateComment(field)
if p.Description != "" && validateComment != "" {
p.Description = p.Description + "," + validateComment
} else if validateComment != "" {
p.Description = validateComment
}
p.In = "query"
p.Required = generator.GetFieldRequired(field, t.Reg, input)
typ, isArray, format := getFieldSwaggerType(field)
if isArray {
p.Items = &swaggerItemsObject{}
p.Type = "array"
p.Items.Type = typ
p.Items.Format = format
} else {
p.Type = typ
p.Format = format
}
return p
}
func (t *swaggerGen) schemaForField(file *descriptor.FileDescriptorProto,
msg *typemap.MessageDefinition,
field *descriptor.FieldDescriptorProto) swaggerSchemaObject {
schema := swaggerSchemaObject{}
fComment, err := t.Reg.FieldComments(msg, field)
if err != nil {
gen.Error(err, "comment not found err %+v")
}
schema.Description = strings.Trim(fComment.Leading, "\n\r ")
validateComment := getValidateComment(field)
if schema.Description != "" && validateComment != "" {
schema.Description = schema.Description + "," + validateComment
} else if validateComment != "" {
schema.Description = validateComment
}
typ, isArray, format := getFieldSwaggerType(field)
if !generator.IsScalar(field) {
if generator.IsMap(field, t.Reg) {
schema.Type = "object"
mapMsg := t.Reg.MessageDefinition(field.GetTypeName())
mapValueField := mapMsg.Descriptor.Field[1]
valSchema := t.schemaForField(file, mapMsg, mapValueField)
schema.AdditionalProperties = &valSchema
} else {
if isArray {
schema.Items = &swaggerItemsObject{}
schema.Type = "array"
schema.Items.Ref = "#/definitions/" + field.GetTypeName()
} else {
schema.Ref = "#/definitions/" + field.GetTypeName()
}
}
} else {
if isArray {
schema.Items = &swaggerItemsObject{}
schema.Type = "array"
schema.Items.Type = typ
schema.Items.Format = format
} else {
schema.Type = typ
schema.Format = format
}
}
return schema
}
func (t *swaggerGen) walkThroughFileDefinition(file *descriptor.FileDescriptorProto) {
for _, svc := range file.Service {
for _, meth := range svc.Method {
shouldGen := t.ShouldGenForMethod(file, svc, meth)
if !shouldGen {
continue
}
t.walkThroughMessages(t.Reg.MessageDefinition(meth.GetOutputType()))
t.walkThroughMessages(t.Reg.MessageDefinition(meth.GetInputType()))
}
}
}
func (t *swaggerGen) walkThroughMessages(msg *typemap.MessageDefinition) {
_, ok := t.defsMap[msg.ProtoName()]
if ok {
return
}
if !msg.Descriptor.GetOptions().GetMapEntry() {
t.defsMap[msg.ProtoName()] = msg
}
for _, field := range msg.Descriptor.Field {
if field.GetType() == descriptor.FieldDescriptorProto_TYPE_MESSAGE {
t.walkThroughMessages(t.Reg.MessageDefinition(field.GetTypeName()))
}
}
}
func getFieldSwaggerType(field *descriptor.FieldDescriptorProto) (typeName string, isArray bool, formatName string) {
typeName = "unknown"
switch field.GetType() {
case descriptor.FieldDescriptorProto_TYPE_BOOL:
typeName = "boolean"
case descriptor.FieldDescriptorProto_TYPE_DOUBLE:
typeName = "number"
formatName = "double"
case descriptor.FieldDescriptorProto_TYPE_FLOAT:
typeName = "number"
formatName = "float"
case
descriptor.FieldDescriptorProto_TYPE_INT64,
descriptor.FieldDescriptorProto_TYPE_UINT64,
descriptor.FieldDescriptorProto_TYPE_INT32,
descriptor.FieldDescriptorProto_TYPE_FIXED64,
descriptor.FieldDescriptorProto_TYPE_FIXED32,
descriptor.FieldDescriptorProto_TYPE_ENUM,
descriptor.FieldDescriptorProto_TYPE_UINT32,
descriptor.FieldDescriptorProto_TYPE_SFIXED32,
descriptor.FieldDescriptorProto_TYPE_SFIXED64,
descriptor.FieldDescriptorProto_TYPE_SINT32,
descriptor.FieldDescriptorProto_TYPE_SINT64:
typeName = "integer"
case
descriptor.FieldDescriptorProto_TYPE_STRING,
descriptor.FieldDescriptorProto_TYPE_BYTES:
typeName = "string"
case descriptor.FieldDescriptorProto_TYPE_MESSAGE:
typeName = "object"
}
if field.Label != nil && *field.Label == descriptor.FieldDescriptorProto_LABEL_REPEATED {
isArray = true
}
return
}
func getValidateComment(field *descriptor.FieldDescriptorProto) string {
var (
tags []reflect.StructTag
)
//get required info from gogoproto.moretags
moretags := tag.GetMoreTags(field)
if moretags != nil {
tags = []reflect.StructTag{reflect.StructTag(*moretags)}
}
validateTag := tag.GetTagValue("validate", tags)
// trim
regStr := []string{
"required *,*",
"omitempty *,*",
}
for _, v := range regStr {
re, _ := regexp.Compile(v)
validateTag = re.ReplaceAllString(validateTag, "")
}
return validateTag
}