feat: add merged spec document

Author: amirsalarsafaei

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

@@ -1,3 +1,7 @@
 package genopenapiv3
 
-const OpenAPIVersion = "3.0.2"
+const (
+	OpenAPIVersion = "3.0.2"
+
+	statusProtoFQMN = ".google.rpc.Status"
+)

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

@@ -5,6 +5,76 @@ import (
 	"github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv3/options"
 )
 
+func convertFileOptions(target *descriptor.File) *openapi3.T {
+	if openAPIAno := proto.GetExtension(target.GetOptions(), options.E_Openapiv3Document).(*options.OpenAPI); openAPIAno != nil {
+		return &openapi3.T{
+			OpenAPI:  OpenAPIVersion,
+			Info:     convertInfo(openAPIAno.GetInfo()),
+			Security: *convertSecurityRequiremnt(openAPIAno.GetSecurity()),
+			Servers:  convertServers(openAPIAno.GetServers()),
+		}
+	}
+
+	return &openapi3.T{OpenAPI: OpenAPIVersion}
+}
+
+func 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 convertInfo(openAPIInfo *options.Info) *openapi3.Info {
+	return &openapi3.Info{
+		Title:          openAPIInfo.GetTitle(),
+		Description:    openAPIInfo.GetDescription(),
+		Version:        openAPIInfo.GetVersion(),
+		TermsOfService: openAPIInfo.GetTermsOfService(),
+		Contact:        convertContact(openAPIInfo.GetContact()),
+		License:        convertLicense(openAPIInfo.GetLicense()),
+	}
+}
+
+func convertContact(contactOption *options.Contact) *openapi3.Contact {
+	if contactOption == nil {
+		return nil
+	}
+
+	return &openapi3.Contact{
+		Name:  contactOption.GetName(),
+		URL:   contactOption.GetUrl(),
+		Email: contactOption.GetEmail(),
+	}
+}
+
+func convertLicense(licenseOption *options.License) *openapi3.License {
+	if licenseOption == nil {
+		return nil
+	}
+
+	return &openapi3.License{
+		Name: licenseOption.GetName(),
+		URL:  licenseOption.GetUrl(),
+	}
+}
 func convertSecurityRequiremnt(requirements []*options.SecurityRequirement) *openapi3.SecurityRequirements {
 	oAPIReqs := openapi3.NewSecurityRequirements()
 
@@ -19,3 +89,4 @@ func convertSecurityRequiremnt(requirements []*options.SecurityRequirement) *ope
 
 	return oAPIReqs
 }
+

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

@@ -19,15 +19,10 @@ type fileGenerator struct {
 }
 
 func (fg *fileGenerator) generateFileDoc(file *descriptor.File) *openapi3.T {
-	var ok bool
-	fg.doc, ok = fg.extractFileOptions(file)
-	if !ok {
-		fg.doc = &openapi3.T{
-			OpenAPI: OpenAPIVersion,
-		}
-	}
 
-	fg.doc.Components = new(openapi3.Components)
+	fg.doc = convertFileOptions(file)
+
+	fg.doc.Components = &openapi3.Components{}
 	fg.doc.Components.Schemas = make(openapi3.Schemas)
 	fg.doc.Components.RequestBodies = make(openapi3.RequestBodies)
 
@@ -250,7 +245,7 @@ func (fg *fileGenerator) getEnumSchema(enum *descriptor.Enum) *openapi3.SchemaRe
 }
 
 func (fg *fileGenerator) generateEnumSchema(enum *descriptor.Enum) *openapi3.Schema {
-	var enumValues []interface{}
+	var enumValues []any
 	for _, value := range enum.GetValue() {
 		enumValues = append(enumValues, value.GetName())
 	}

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

@@ -35,10 +35,12 @@ func (g *generator) Generate(targets []*descriptor.File) ([]*descriptor.Response
 		return nil, fmt.Errorf("could not load prequisite proto files in registry: %w", err)
 	}
 
-	respFiles := make([]*descriptor.ResponseFile, len(targets))
-	for i, t := range targets {
+	respFiles := make([]*descriptor.ResponseFile, 0, len(targets))
+	docs := make([]*openapi3.T, 0, len(targets))
+	for _, t := range targets {
 		fileGenerator := &fileGenerator{generator: g, doc: &openapi3.T{}}
 		doc := fileGenerator.generateFileDoc(t)
+		docs = append(docs, doc)
 
 		contentBytes, err := g.format.MarshalOpenAPIDoc(doc)
 		if err != nil {
@@ -49,15 +51,32 @@ func (g *generator) Generate(targets []*descriptor.File) ([]*descriptor.Response
 		ext := filepath.Ext(base)
 		fileName := fmt.Sprintf("%s.openapiv3.%s", base[:len(base)-len(ext)], g.format)
 
-		respFiles[i] = &descriptor.ResponseFile{
-			GoPkg: t.GoPkg,
+		respFiles = append(respFiles, &descriptor.ResponseFile{
 			CodeGeneratorResponse_File: &pluginpb.CodeGeneratorResponse_File{
 				Name:    proto.String(fileName),
 				Content: proto.String(string(contentBytes)),
 			},
-		}
+		})
+
+	}
+
+	mergedDocs, err := MergeOpenAPISpecs(docs...)
+	if err != nil {
+		return nil, fmt.Errorf("could not merge docs: %w", err)
 	}
 
+	contentBytes, err := g.format.MarshalOpenAPIDoc(mergedDocs)
+	if err != nil {
+		return nil, err
+	}
+
+	respFiles = append(respFiles, &descriptor.ResponseFile{
+		CodeGeneratorResponse_File: &pluginpb.CodeGeneratorResponse_File{
+			Name:    proto.String(fmt.Sprintf("merged.openapiv3.%s", g.format)),
+			Content: proto.String(string(contentBytes)),
+		},
+	})
+
 	return respFiles, nil
 }
 
@@ -98,7 +117,7 @@ func (g *generator) loadPrequisiteProtos() error {
 }
 
 func (g *generator) defaultResponse() (*descriptor.Message, error) {
-	return g.reg.LookupMsg("", ".google.rpc.Status")
+	return g.reg.LookupMsg("", statusProtoFQMN)
 }
 
 func extractOperationOptionFromMethodDescriptor(meth *descriptorpb.MethodDescriptorProto) (*options.Operation, error) {