Add operationId to Swagger output.

Swagger uses the operationId as the "nickname" for the method generated for your service.
xueyejus · Jan 14, 2016 · 6e9bc39 · 6e9bc39
1 parent 96f971a
commit 6e9bc39
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 5 deletions.
diff --git a/examples/examplepb/echo_service.swagger.json b/examples/examplepb/echo_service.swagger.json
@@ -18,6 +18,7 @@
     "/v1/example/echo/{id}": {
       "post": {
         "summary": "EchoService.Echo",
+        "operationId": "Echo",
         "responses": {
           "default": {
             "description": "Description",
@@ -40,6 +41,7 @@
     "/v1/example/echo_body": {
       "post": {
         "summary": "EchoService.EchoBody",
+        "operationId": "EchoBody",
         "responses": {
           "default": {
             "description": "Description",

diff --git a/examples/examplepb/streamless_everything.swagger.json b/examples/examplepb/streamless_everything.swagger.json
@@ -18,6 +18,7 @@
     "/v1/example/a_bit_of_everything": {
       "get": {
         "summary": "ABitOfEverythingService.List",
+        "operationId": "List",
         "responses": {
           "default": {
             "description": "Description",
@@ -31,6 +32,7 @@
     "/v1/example/a_bit_of_everything/bulk": {
       "post": {
         "summary": "ABitOfEverythingService.BulkCreate",
+        "operationId": "BulkCreate",
         "responses": {
           "default": {
             "description": "Description",
@@ -54,6 +56,7 @@
     "/v1/example/a_bit_of_everything/echo": {
       "post": {
         "summary": "ABitOfEverythingService.BulkEcho",
+        "operationId": "BulkEcho",
         "responses": {
           "default": {
             "description": "Description",
@@ -77,6 +80,7 @@
     "/v1/example/a_bit_of_everything/echo/{value}": {
       "get": {
         "summary": "ABitOfEverythingService.Echo",
+        "operationId": "Echo",
         "responses": {
           "default": {
             "description": "Description",
@@ -99,6 +103,7 @@
     "/v1/example/a_bit_of_everything/{float_value}/{double_value}/{int64_value}/separator/{uint64_value}/{int32_value}/{fixed64_value}/{fixed32_value}/{bool_value}/{string_value}/{uint32_value}/{sfixed32_value}/{sfixed64_value}/{sint32_value}/{sint64_value}": {
       "post": {
         "summary": "ABitOfEverythingService.Create",
+        "operationId": "Create",
         "responses": {
           "default": {
             "description": "Description",
@@ -212,6 +217,7 @@
     "/v1/example/a_bit_of_everything/{uuid}": {
       "delete": {
         "summary": "ABitOfEverythingService.Delete",
+        "operationId": "Delete",
         "responses": {
           "default": {
             "description": "Description",

diff --git a/protoc-gen-swagger/genswagger/template.go b/protoc-gen-swagger/genswagger/template.go
@@ -357,8 +357,9 @@ func renderServices(services []*descriptor.Service, paths swaggerPathsObject) er
 
 				pathItemObject := swaggerPathItemObject{}
 				operationObject := &swaggerOperationObject{
-					Summary:    fmt.Sprintf("%s.%s", svc.GetName(), meth.GetName()),
-					Parameters: parameters,
+					Summary:     fmt.Sprintf("%s.%s", svc.GetName(), meth.GetName()),
+					OperationId: fmt.Sprintf("%s", meth.GetName()),
+					Parameters:  parameters,
 					Responses: swaggerResponsesObject{
 						"default": swaggerResponseObject{
 							Description: "Description",

diff --git a/protoc-gen-swagger/genswagger/types.go b/protoc-gen-swagger/genswagger/types.go
@@ -45,9 +45,10 @@ type swaggerPathItemObject struct {
 
 // http://swagger.io/specification/#operationObject
 type swaggerOperationObject struct {
-	Summary    string                  `json:"summary"`
-	Responses  swaggerResponsesObject  `json:"responses"`
-	Parameters swaggerParametersObject `json:"parameters,omitempty"`
+	Summary     string                  `json:"summary"`
+	OperationId string                  `json:"operationId"`
+	Responses   swaggerResponsesObject  `json:"responses"`
+	Parameters  swaggerParametersObject `json:"parameters,omitempty"`
 }
 
 type swaggerParametersObject []swaggerParameterObject