Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support map types in swagger generator #141

Merged
merged 2 commits into from
May 9, 2016
Merged

Support map types in swagger generator #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95bb0a6
Fix swagger generator to treat map<string, V> as a swagger map object
t-yuki Apr 28, 2016
6c01d4f
update grpc-go and examples
t-yuki May 2, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
254 changes: 156 additions & 98 deletions examples/examplepb/a_bit_of_everything.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions examples/examplepb/a_bit_of_everything.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ message ABitOfEverything {
sint32 sint32_value = 17;
sint64 sint64_value = 18;
repeated string repeated_string_value = 19;
map<string, string> mapped_string_value = 20;
map<string, Nested> mapped_nested_value = 21;
}

message EmptyMessage {
Expand Down
34 changes: 23 additions & 11 deletions examples/examplepb/echo_service.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

66 changes: 45 additions & 21 deletions examples/examplepb/flow_combination.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions examples/examplepb/streamless_everything.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ message ABitOfEverything {
sint32 sint32_value = 17;
sint64 sint64_value = 18;
repeated string repeated_string_value = 19;
map<string, string> mapped_string_value = 20;
map<string, Nested> mapped_nested_value = 21;
}

message EmptyMessage {
Expand Down
13 changes: 13 additions & 0 deletions examples/examplepb/streamless_everything.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,19 @@
"type": "integer",
"format": "int64"
},
"mapped_nested_value": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ABitOfEverythingNested"
}
},
"mapped_string_value": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "string"
}
},
"nested": {
"type": "array",
"items": {
Expand Down
43 changes: 36 additions & 7 deletions protoc-gen-swagger/genswagger/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,28 @@ func findNestedMessagesAndEnumerations(message *descriptor.Message, reg *descrip

func renderMessagesAsDefinition(messages messageMap, d swaggerDefinitionsObject, reg *descriptor.Registry) {
for _, msg := range messages {
if opt := msg.GetOptions(); opt != nil && opt.MapEntry != nil && *opt.MapEntry {
continue
}
object := swaggerSchemaObject{
Type: "object",
Type: "object",
Properties: map[string]swaggerSchemaObject{},
}
for _, field := range msg.Fields {
fieldDescriptor := field.FieldDescriptorProto
mapEntry := false
if fieldMessage, err := reg.LookupMsg("", field.GetTypeName()); err == nil {
if opt := fieldMessage.GetOptions(); opt != nil && opt.MapEntry != nil && *opt.MapEntry {
fieldDescriptor = fieldMessage.GetField()[1]
mapEntry = true
}
}

var fieldType, fieldFormat string
primitive := true
// Field type and format from http://swagger.io/specification/ in the
// "Data Types" table
switch field.FieldDescriptorProto.Type.String() {
switch fieldDescriptor.Type.String() {
case "TYPE_DOUBLE":
fieldType = "number"
fieldFormat = "double"
Expand Down Expand Up @@ -142,30 +154,47 @@ func renderMessagesAsDefinition(messages messageMap, d swaggerDefinitionsObject,
}

if primitive {
// If repeated render as an array of items.
if field.FieldDescriptorProto.GetLabel() == pbdescriptor.FieldDescriptorProto_LABEL_REPEATED {
switch {
case mapEntry:
object.Properties[field.GetName()] = swaggerSchemaObject{
Type: "object",
AdditionalProperties: &swaggerSchemaObject{
Type: fieldType,
Format: fieldFormat,
},
}
case field.FieldDescriptorProto.GetLabel() == pbdescriptor.FieldDescriptorProto_LABEL_REPEATED:
// If repeated render as an array of items.
object.Properties[field.GetName()] = swaggerSchemaObject{
Type: "array",
Items: &swaggerItemsObject{
Type: fieldType,
Format: fieldFormat,
},
}
} else {
default:
object.Properties[field.GetName()] = swaggerSchemaObject{
Type: fieldType,
Format: fieldFormat,
}
}
} else {
if field.FieldDescriptorProto.GetLabel() == pbdescriptor.FieldDescriptorProto_LABEL_REPEATED {
switch {
case mapEntry:
object.Properties[field.GetName()] = swaggerSchemaObject{
Type: "object",
AdditionalProperties: &swaggerSchemaObject{
Ref: "#/definitions/" + fullyQualifiedNameToSwaggerName(fieldDescriptor.GetTypeName(), reg),
},
}
case field.FieldDescriptorProto.GetLabel() == pbdescriptor.FieldDescriptorProto_LABEL_REPEATED:
object.Properties[field.GetName()] = swaggerSchemaObject{
Type: "array",
Items: &swaggerItemsObject{
Ref: "#/definitions/" + fullyQualifiedNameToSwaggerName(field.GetTypeName(), reg),
},
}
} else {
default:
object.Properties[field.GetName()] = swaggerSchemaObject{
Ref: "#/definitions/" + fullyQualifiedNameToSwaggerName(field.GetTypeName(), reg),
}
Expand Down
5 changes: 3 additions & 2 deletions protoc-gen-swagger/genswagger/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,9 @@ type swaggerSchemaObject struct {
Type string `json:"type,omitempty"`
Format string `json:"format,omitempty"`
// Properties can be recursively defined
Properties map[string]swaggerSchemaObject `json:"properties,omitempty"`
Items *swaggerItemsObject `json:"items,omitempty"`
Properties map[string]swaggerSchemaObject `json:"properties,omitempty"`
AdditionalProperties *swaggerSchemaObject `json:"additionalProperties,omitempty"`
Items *swaggerItemsObject `json:"items,omitempty"`

// If the item is an enumeration include a list of all the *NAMES* of the
// enum values. I'm not sure how well this will work but assuming all enums
Expand Down