Merge pull request #148 from gengo/swagger_dot_in_path_template

Swagger dot in path template
grpc-ecosystem · May 9, 2016 · 1d571c7 · 1d571c7
2 parents 8205819 + 6087747
commit 1d571c7
Show file tree

Hide file tree

Showing 7 changed files with 240 additions and 72 deletions.
diff --git a/examples/examplepb/a_bit_of_everything.pb.go b/examples/examplepb/a_bit_of_everything.pb.go
diff --git a/examples/examplepb/a_bit_of_everything.pb.gw.go b/examples/examplepb/a_bit_of_everything.pb.gw.go
diff --git a/examples/examplepb/a_bit_of_everything.proto b/examples/examplepb/a_bit_of_everything.proto
@@ -6,6 +6,8 @@ import "google/api/annotations.proto";
 import "examples/sub/message.proto";
 import "examples/sub2/message.proto";
 
+// Intentionaly complicated message type to cover much features of Protobuf.
+// NEXT ID: 26
 message ABitOfEverything {
 	message Nested {
 		string name = 1;
@@ -16,6 +18,7 @@ message ABitOfEverything {
 		}
 		DeepEnum ok = 3;
 	}
+	Nested single_nested = 25;
 
 	string uuid = 1;
 	repeated Nested nested = 2;
@@ -112,4 +115,10 @@ service ABitOfEverythingService {
 			body: "*"
 		};
 	}
+	rpc DeepPathEcho(ABitOfEverything) returns (ABitOfEverything) {
+		option (google.api.http) = {
+			post: "/v1/example/a_bit_of_everything/{single_nested.name}"
+			body: "*"
+		};
+	}
 }
diff --git a/examples/examplepb/streamless_everything.proto b/examples/examplepb/streamless_everything.proto
@@ -5,6 +5,8 @@ package gengo.grpc.gateway.examples.examplepb;
 import "google/api/annotations.proto";
 import "examples/sub/message.proto";
 
+// Intentionaly complicated message type to cover much features of Protobuf.
+// NEXT ID: 26
 message ABitOfEverything {
 	message Nested {
 		string name = 1;
@@ -15,6 +17,7 @@ message ABitOfEverything {
 		}
 		DeepEnum ok = 3;
 	}
+	Nested single_nested = 25;
 
 	string uuid = 1;
 	repeated Nested nested = 2;
@@ -115,4 +118,10 @@ service ABitOfEverythingService {
 			body: "*"
 		};
 	}
+	rpc DeepPathEcho(ABitOfEverything) returns (ABitOfEverything) {
+		option (google.api.http) = {
+			post: "/v1/example/a_bit_of_everything/{single_nested.name}"
+			body: "*"
+		};
+	}
 }
diff --git a/examples/examplepb/streamless_everything.swagger.json b/examples/examplepb/streamless_everything.swagger.json
@@ -254,6 +254,40 @@
         ]
       }
     },
+    "/v1/example/a_bit_of_everything/{single_nested.name}": {
+      "post": {
+        "summary": "ABitOfEverythingService.DeepPathEcho",
+        "operationId": "DeepPathEcho",
+        "responses": {
+          "default": {
+            "description": "Description",
+            "schema": {
+              "$ref": "#/definitions/examplepbABitOfEverything"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "single_nested.name",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "format": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/examplepbABitOfEverything"
+            }
+          }
+        ],
+        "tags": [
+          "ABitOfEverythingService"
+        ]
+      }
+    },
     "/v1/example/a_bit_of_everything/{uuid}": {
       "get": {
         "summary": "ABitOfEverythingService.Lookup",
@@ -443,6 +477,9 @@
           "type": "integer",
           "format": "int32"
         },
+        "single_nested": {
+          "$ref": "#/definitions/ABitOfEverythingNested"
+        },
         "sint32_value": {
           "type": "integer",
           "format": "int32"

diff --git a/examples/server/a_bit_of_everything.go b/examples/server/a_bit_of_everything.go
@@ -206,3 +206,11 @@ func (s *_ABitOfEverythingServer) BulkEcho(stream examples.ABitOfEverythingServi
 	}))
 	return nil
 }
+
+func (s *_ABitOfEverythingServer) DeepPathEcho(ctx context.Context, msg *examples.ABitOfEverything) (*examples.ABitOfEverything, error) {
+	s.m.Lock()
+	defer s.m.Unlock()
+
+	glog.Info(msg)
+	return msg, nil
+}
diff --git a/protoc-gen-swagger/genswagger/template.go b/protoc-gen-swagger/genswagger/template.go
@@ -284,7 +284,7 @@ func templateToSwaggerPath(path string) string {
 	// Parts is now an array of segments of the path. Interestingly, since the
 	// syntax for this subsection CAN be handled by a regexp since it has no
 	// memory.
-	re := regexp.MustCompile("{([a-z][a-z0-9_]*).*}")
+	re := regexp.MustCompile("{([a-z][a-z0-9_.]*).*}")
 	for index, part := range parts {
 		parts[index] = re.ReplaceAllString(part, "{$1}")
 	}