Camel case backward compatible in Swagger doc (#988)

* Avoid potential out of range and support the convention that could be inside * Add some test cases for testing backward compatible
grpc-ecosystem · Aug 10, 2019 · 86e5755 · 86e5755
1 parent b6e6efb
commit 86e5755
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/protoc-gen-swagger/genswagger/template.go b/protoc-gen-swagger/genswagger/template.go
@@ -626,7 +626,7 @@ func templateToSwaggerPath(path string, reg *descriptor.Registry) string {
 			buffer += string(char)
 			if reg.GetUseJSONNamesForFields() &&
 				len(jsonBuffer) > 1 {
-				jsonSnakeCaseName := string(jsonBuffer[1 : len(buffer)-1])
+				jsonSnakeCaseName := string(jsonBuffer[1:])
 				jsonCamelCaseName := string(lowerCamelCase(jsonSnakeCaseName))
 				prev := string(buffer[:len(buffer)-len(jsonSnakeCaseName)-2])
 				buffer = strings.Join([]string{prev, "{", jsonCamelCaseName, "}"}, "")
@@ -641,6 +641,7 @@ func templateToSwaggerPath(path string, reg *descriptor.Registry) string {
 				continue
 			}
 			buffer += string(char)
+			jsonBuffer += string(char)
 		default:
 			buffer += string(char)
 			jsonBuffer += string(char)

diff --git a/protoc-gen-swagger/genswagger/template_test.go b/protoc-gen-swagger/genswagger/template_test.go
@@ -914,6 +914,14 @@ func TestTemplateToSwaggerPath(t *testing.T) {
 		{"/{parent=prefix/*}/children:customMethod", "/{parent=prefix/*}/children:customMethod"},
 	}
 	reg := descriptor.NewRegistry()
+	reg.SetUseJSONNamesForFields(false)
+	for _, data := range tests {
+		actual := templateToSwaggerPath(data.input, reg)
+		if data.expected != actual {
+			t.Errorf("Expected templateToSwaggerPath(%v) = %v, actual: %v", data.input, data.expected, actual)
+		}
+	}
+	reg.SetUseJSONNamesForFields(true)
 	for _, data := range tests {
 		actual := templateToSwaggerPath(data.input, reg)
 		if data.expected != actual {
@@ -991,6 +999,14 @@ func TestFQMNtoSwaggerName(t *testing.T) {
 		{"/{test1}/{test2}/", "/{test1}/{test2}/"},
 	}
 	reg := descriptor.NewRegistry()
+	reg.SetUseJSONNamesForFields(false)
+	for _, data := range tests {
+		actual := templateToSwaggerPath(data.input, reg)
+		if data.expected != actual {
+			t.Errorf("Expected templateToSwaggerPath(%v) = %v, actual: %v", data.input, data.expected, actual)
+		}
+	}
+	reg.SetUseJSONNamesForFields(true)
 	for _, data := range tests {
 		actual := templateToSwaggerPath(data.input, reg)
 		if data.expected != actual {