Add servers to generator

Author: Josh

internal/generator/generator.go

@@ -302,6 +302,16 @@ func addFileServersToDoc(doc *openapi3.T, file *protogen.File) error {
 			}
 			doc.Servers = append(doc.Servers, server)
 		}
+
+		if len(fileOptions.Servers) > 0 {
+			for _, fileServer := range fileOptions.Servers {
+				server, err := NewServer(fileServer.Url)
+				if err != nil {
+					return err
+				}
+				doc.Servers = append(doc.Servers, server)
+			}
+		}
 	}
 
 	return nil

internal/generator/path.go

@@ -60,6 +60,8 @@ func (g *Generator) addPathsToDoc(doc *openapi3.T, services []*protogen.Service)
 
 		security := make([]*oapiv1.Security, 0)
 
+		var servers openapi3.Servers
+
 		if serviceOptions.Host != "" {
 			// Use service defined host.
 			host = serviceOptions.Host
@@ -70,6 +72,19 @@ func (g *Generator) addPathsToDoc(doc *openapi3.T, services []*protogen.Service)
 			}
 
 			doc.Servers = append(doc.Servers, server)
+			servers = append(servers, server)
+		}
+
+		if len(serviceOptions.Servers) > 0 {
+			for _, serviceServer := range serviceOptions.Servers {
+				server, err := NewServer(serviceServer.Url)
+				if err != nil {
+					return err
+				}
+
+				doc.Servers = append(doc.Servers, server)
+				servers = append(servers, server)
+			}
 		}
 
 		if serviceOptions.Prefix != "" {
@@ -138,6 +153,7 @@ func (g *Generator) addPathsToDoc(doc *openapi3.T, services []*protogen.Service)
 				packageName:       packageName,
 				serviceParameters: parameters,
 				security:          security,
+				servers:           servers,
 			})
 			if err != nil {
 				return err
@@ -244,6 +260,7 @@ type addOperationParams struct {
 	method            *protogen.Method
 	serviceOptions    *oapiv1.ServiceOptions
 	host              string
+	servers           openapi3.Servers
 	contentType       string
 	tagName           string
 	pathPrefix        string
@@ -255,7 +272,7 @@ type addOperationParams struct {
 // addOperation creates an operation for a path and adds it.
 // TODO: Break into smaller bits.
 func (g *Generator) addOperation(p addOperationParams) error {
-	host := p.host
+	servers := p.servers
 	contentType := p.contentType
 
 	operationID := string(p.service.Desc.Name() + "_" + p.method.Desc.Name())
@@ -272,8 +289,26 @@ func (g *Generator) addOperation(p addOperationParams) error {
 	}
 
 	if methodOptions.Host != "" {
-		// Use service defined host.
-		host = methodOptions.Host
+		server, err := NewServer(methodOptions.Host)
+		if err != nil {
+			return err
+		}
+		p.doc.Servers = append(p.doc.Servers, server)
+		servers = append(servers, server)
+	}
+
+	if len(methodOptions.Servers) > 0 {
+		// If defined at the method level, delete what came from service.
+		servers = openapi3.Servers{}
+		for _, methodServer := range methodOptions.Servers {
+			server, err := NewServer(methodServer.Url)
+			if err != nil {
+				return err
+			}
+
+			p.doc.Servers = append(p.doc.Servers, server)
+			servers = append(servers, server)
+		}
 	}
 
 	if methodOptions.ContentType != "" {
@@ -299,20 +334,13 @@ func (g *Generator) addOperation(p addOperationParams) error {
 		}
 	}
 
-	// Append the defined host as a server. Duplicates are removed later.
-	server, err := NewServer(host)
-	if err != nil {
-		return err
-	}
-	p.doc.Servers = append(p.doc.Servers, server)
-
 	var methodPath, methodName string
 
 	op := &openapi3.Operation{
 		Tags:        []string{p.tagName},
 		Description: description,
 		OperationID: operationID,
-		Servers:     &openapi3.Servers{server},
+		Servers:     &servers,
 		Deprecated:  methodOptions.Deprecated,
 		Responses:   make(openapi3.Responses),
 		Summary:     methodOptions.Summary,

test/file_test.proto

@@ -9,6 +9,15 @@ option go_package = "github.com/technicallyjosh/protoc-gen-openapi/test_api";
 option (oapi.v1.file) = {
   host: "swagger.io"
 
+  servers: [
+    {
+      url: "swagger.one"
+    },
+    {
+      url: "swagger.two"
+    }
+  ]
+
   security_schemes: {
     name: "bearer_auth"
     scheme: {

test/file_test_openapi.yaml

@@ -9,6 +9,8 @@ paths: { }
 
 servers:
   - url: https://swagger.io
+  - url: https://swagger.one
+  - url: https://swagger.two
 
 components:
   responses:

test/method_test.proto

@@ -23,6 +23,11 @@ service TestService {
   rpc TestEmptyPost(TestEmptyPostRequest) returns (TestEmptyPostResponse) {
     option (oapi.v1.method) = {
       post: "TestEmptyPost"
+      servers: [
+        {
+          url: "test.swagger.io"
+        }
+      ]
     };
   };
 }

test/method_test_openapi.yaml

@@ -13,18 +13,18 @@ paths:
         content:
           application/json:
             schema:
-              properties: {}
+              properties: { }
       responses:
         '200':
           content:
             application/json:
               schema:
-                properties: {}
+                properties: { }
           description: ''
         default:
           $ref: '#/components/responses/default'
       servers:
-        - url: https://api.swagger.io
+        - url: https://test.swagger.io
       tags:
         - TestService
 
@@ -47,6 +47,7 @@ components:
 servers:
   - url: https://swagger.io
   - url: https://api.swagger.io
+  - url: https://test.swagger.io
 
 tags:
   - name: TestService