fix: generation path and encoder indentation

Author: amirsalarsafaei

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

@@ -6,24 +6,24 @@ import (
 	"strings"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
-	gen "github.com/grpc-ecosystem/grpc-gateway/v2/internal/generator"
-	"github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv3/options"
 	"google.golang.org/genproto/googleapis/api/visibility"
 	statuspb "google.golang.org/genproto/googleapis/rpc/status"
 	"google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/reflect/protodesc"
 	"google.golang.org/protobuf/types/descriptorpb"
 	"google.golang.org/protobuf/types/known/anypb"
 	"google.golang.org/protobuf/types/pluginpb"
+
+	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
+	gen "github.com/grpc-ecosystem/grpc-gateway/v2/internal/generator"
+	"github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv3/options"
 )
 
 type generator struct {
 	reg    *descriptor.Registry
 	format Format
 }
 
-
 func NewGenerator(reg *descriptor.Registry, format Format) gen.Generator {
 	return &generator{
 		reg:    reg,
@@ -37,6 +37,10 @@ func (g *generator) Generate(targets []*descriptor.File) ([]*descriptor.Response
 		return nil, fmt.Errorf("could not load prequisite proto files in registry: %w", err)
 	}
 
+	if len(targets) == 0 {
+		return nil, nil
+	}
+
 	respFiles := make([]*descriptor.ResponseFile, 0, len(targets))
 	docs := make([]*openapi3.T, 0, len(targets))
 	for _, t := range targets {
@@ -50,12 +54,14 @@ func (g *generator) Generate(targets []*descriptor.File) ([]*descriptor.Response
 		}
 
 		base := filepath.Base(t.GetName())
+		fileDir := filepath.Dir(t.GetName())
 		ext := filepath.Ext(base)
 		fileName := fmt.Sprintf("%s.openapiv3.%s", base[:len(base)-len(ext)], g.format)
+		docPath := filepath.Join(fileDir, fileName)
 
 		respFiles = append(respFiles, &descriptor.ResponseFile{
 			CodeGeneratorResponse_File: &pluginpb.CodeGeneratorResponse_File{
-				Name:    proto.String(fileName),
+				Name:    proto.String(docPath),
 				Content: proto.String(string(contentBytes)),
 			},
 		})
@@ -72,9 +78,12 @@ func (g *generator) Generate(targets []*descriptor.File) ([]*descriptor.Response
 		return nil, err
 	}
 
+	mergedDir := filepath.Dir(targets[0].GetName())
+	mergedPath := filepath.Join(mergedDir, fmt.Sprintf("merged.openapiv3.%s", g.format))
+
 	respFiles = append(respFiles, &descriptor.ResponseFile{
 		CodeGeneratorResponse_File: &pluginpb.CodeGeneratorResponse_File{
-			Name:    proto.String(fmt.Sprintf("merged.openapiv3.%s", g.format)),
+			Name:    proto.String(mergedPath),
 			Content: proto.String(string(contentBytes)),
 		},
 	})

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

@@ -1,7 +1,10 @@
 package genopenapiv3
 
 import (
+	"bytes"
+	"encoding/json"
 	"errors"
+	"fmt"
 
 	"github.com/getkin/kin-openapi/openapi3"
 	"google.golang.org/grpc/grpclog"
@@ -17,21 +20,38 @@ const (
 
 var ErrUnSupportedFormat = errors.New("unsupported format provided")
 
+type Encoder interface {
+	Encode(v any) error
+}
 
 func (f Format) MarshalOpenAPIDoc(doc *openapi3.T) ([]byte, error) {
+
+	openapiDoc, err := doc.MarshalYAML()
+	if err != nil {
+		return nil, err
+	}
+
+	var buf bytes.Buffer
+	var encoder Encoder
+
 	switch f {
 	case FormatJSON:
-		return doc.MarshalJSON()
+		encoder = json.NewEncoder(&buf)
+		encoder.(*json.Encoder).SetIndent("", "  ")
 	case FormatYAML:
-		openapiDoc, err := doc.MarshalYAML()
-		if err != nil {
-			return nil, err
-		}
-		return yaml.Marshal(openapiDoc)
+		encoder = yaml.NewEncoder(&buf)
+		encoder.(*yaml.Encoder).SetIndent(2)
 	default:
 		grpclog.Errorf("unsupported format: %s\n", f)
 		return nil, ErrUnSupportedFormat
 	}
+
+	err = encoder.Encode(openapiDoc)
+	if err != nil {
+		return nil, fmt.Errorf("failed to encode OpenAPI document: %w", err)
+	}
+
+	return buf.Bytes(), nil
 }
 
 type OneOfStrategy string

protoc-gen-openapiv3/main.go

@@ -6,18 +6,18 @@ import (
 	"os"
 	"strings"
 
+	"google.golang.org/grpc/grpclog"
+	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/types/pluginpb"
+
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/codegenerator"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv3/internal/genopenapiv3"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/utilities"
-	"google.golang.org/grpc/grpclog"
-	"google.golang.org/protobuf/proto"
-	"google.golang.org/protobuf/types/pluginpb"
 )
 
 var (
 	file                           = flag.String("file", "-", "where to load data from")
-	openAPIConfiguration           = flag.String("openapi_configuration", "", "path to file which describes the OpenAPI Configuration in YAML format")
 	oneOfStrategy                  = flag.String("oneof_strategy", "oneOf", "how to handle oneofs")
 	outputFormat                   = flag.String("output_format", string(genopenapiv3.FormatJSON), fmt.Sprintf("output content format. Allowed values are: `%s`, `%s`", genopenapiv3.FormatJSON, genopenapiv3.FormatYAML))
 	visibilityRestrictionSelectors = utilities.StringArrayFlag(flag.CommandLine, "visibility_restriction_selectors", "list of `google.api.VisibilityRule` visibility labels to include in the generated output when a visibility annotation is defined. Repeat this option to supply multiple values. Elements without visibility annotations are unaffected by this setting.")