chore: clean the convertor codes

Author: amirsalarsafaei

protoc-gen-openapiv3/internal/genopenapiv3/convertors.go

@@ -0,0 +1,21 @@
+package genopenapiv3
+
+import (
+	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv3/options"
+)
+
+func convertSecurityRequiremnt(requirements []*options.SecurityRequirement) *openapi3.SecurityRequirements {
+	oAPIReqs := openapi3.NewSecurityRequirements()
+
+	for _, req := range requirements {
+		oAPISecReq := openapi3.NewSecurityRequirement()
+		for authenticator, scopes := range req.GetAdditionalProperties() {
+			oAPISecReq.Authenticate(authenticator, scopes.GetScopes()...)
+		}
+
+		oAPIReqs.With(oAPISecReq)
+	}
+
+	return oAPIReqs
+}

protoc-gen-openapiv3/internal/genopenapiv3/file_generator.go

@@ -8,7 +8,6 @@ import (
 
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
-	"github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv3/options"
 	"google.golang.org/grpc/grpclog"
 	"google.golang.org/protobuf/types/descriptorpb"
 )
@@ -342,7 +341,7 @@ func (fg *fileGenerator) generateMethodDoc(meth *descriptor.Method) error {
 		}
 
 		if opOpts.GetSecurity() != nil {
-			operation.Security = fg.generateSecurity(opOpts.GetSecurity())
+			operation.Security = convertSecurityRequiremnt(opOpts.GetSecurity())
 		}
 
 		path := fg.convertPathTemplate(binding.PathTmpl.Template)
@@ -373,21 +372,6 @@ func (fg *fileGenerator) generateMethodDoc(meth *descriptor.Method) error {
 	return nil
 }
 
-func (fg *fileGenerator) generateSecurity(requirements []*options.SecurityRequirement) *openapi3.SecurityRequirements {
-	res := openapi3.NewSecurityRequirements()
-
-	for _, req := range requirements {
-		oAPISecReq := openapi3.NewSecurityRequirement()
-		for authenticator, scopes := range req.GetAdditionalProperties() {
-			oAPISecReq.Authenticate(authenticator, scopes.GetScopes()...)
-		}
-
-		res.With(oAPISecReq)
-	}
-
-	return res
-}
-
 func (fg *fileGenerator) convertPathTemplate(template string) string {
 	// TODO: handle /{args=foo/*}
 	return template

protoc-gen-openapiv3/internal/genopenapiv3/file_options.go

@@ -7,51 +7,75 @@ import (
 	"google.golang.org/protobuf/proto"
 )
 
-func (g *generator) extractFileOptions(target *descriptor.File) (*openapi3.T, bool) {
+func (g *generator) convertFileOptions(target *descriptor.File) (*openapi3.T, bool) {
 	if openAPIAno := proto.GetExtension(target.GetOptions(), options.E_Openapiv3Document).(*options.OpenAPI); openAPIAno != nil {
 		doc := &openapi3.T{
-			OpenAPI: OpenAPIVersion,
+			OpenAPI:  OpenAPIVersion,
+			Info:     g.convertInfo(openAPIAno.GetInfo()),
+			Security: *convertSecurityRequiremnt(openAPIAno.GetSecurity()),
+			Servers:  g.convertServers(openAPIAno.GetServers()),
 		}
-		doc.Info = g.extractInfo(openAPIAno.GetInfo())
 		// TODO: implement other openapi file annotation fields
 		return doc, true
 	}
 
 	return nil, false
 }
 
-func (g *generator) extractInfo(openAPIInfo *options.Info) *openapi3.Info {
+func (g *generator) convertServers(servers []*options.Server) openapi3.Servers {
+	oAPIservers := make(openapi3.Servers, len(servers))
+
+	for i, srv := range servers {
+		vars := map[string]*openapi3.ServerVariable{}
+
+		for k, v := range srv.GetVariables() {
+			vars[k] = &openapi3.ServerVariable{
+				Enum:        v.GetEnum(),
+				Default:     v.GetDefault(),
+				Description: v.GetDescription(),
+			}
+		}
+
+		oAPIservers[i] = &openapi3.Server{
+			URL:         srv.GetUrl(),
+			Description: srv.GetDescription(),
+			Variables:   vars,
+		}
+	}
+
+	return oAPIservers
+}
+
+func (g *generator) convertInfo(openAPIInfo *options.Info) *openapi3.Info {
 	return &openapi3.Info{
-		Title: openAPIInfo.GetTitle(),
-		Description: openAPIInfo.GetDescription(),
-		Version: openAPIInfo.GetVersion(),
+		Title:          openAPIInfo.GetTitle(),
+		Description:    openAPIInfo.GetDescription(),
+		Version:        openAPIInfo.GetVersion(),
 		TermsOfService: openAPIInfo.GetTermsOfService(),
-		Contact: g.extractContact(openAPIInfo.GetContact()),
-		License: g.extractLicense(openAPIInfo.GetLicense()),
+		Contact:        g.convertContact(openAPIInfo.GetContact()),
+		License:        g.convertLicense(openAPIInfo.GetLicense()),
 	}
 }
 
-func (g *generator) extractContact(contactOption *options.Contact) *openapi3.Contact {
+func (g *generator) convertContact(contactOption *options.Contact) *openapi3.Contact {
 	if contactOption == nil {
 		return nil
 	}
 
-	contact := &openapi3.Contact{}
-	contact.Name = contactOption.GetName()
-	contact.URL = contactOption.GetUrl()
-	contact.Email = contactOption.GetEmail()
-
-	return contact
+	return &openapi3.Contact{
+		Name:  contactOption.GetName(),
+		URL:   contactOption.GetUrl(),
+		Email: contactOption.GetEmail(),
+	}
 }
 
-func (g *generator) extractLicense(licenseOption *options.License) *openapi3.License {
+func (g *generator) convertLicense(licenseOption *options.License) *openapi3.License {
 	if licenseOption == nil {
 		return nil
 	}
 
-	license := &openapi3.License{}
-	license.Name = licenseOption.GetName()
-	license.URL = licenseOption.GetUrl()
-
-	return license
+	return &openapi3.License{
+		Name: licenseOption.GetName(),
+		URL:  licenseOption.GetUrl(),
+	}
 }