Add options to aggregate protos to one file

Author: lucy66hw

bin/configs/protobuf-schema-config.yaml

@@ -8,6 +8,7 @@ additionalProperties:
   numberedFieldNumberList: true
   startEnumsWithUnspecified: true
   wrapComplexType: false
+  aggregateModelsName: data
 typeMappings:
   object: "google.protobuf.Struct"
 importMappings:

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ProtobufSchemaCodegen.java

@@ -42,6 +42,8 @@
 import java.util.*;
 import java.util.Map.Entry;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
 import com.google.common.base.CaseFormat;
 
 import static org.openapitools.codegen.utils.StringUtils.*;
@@ -64,10 +66,14 @@ public class ProtobufSchemaCodegen extends DefaultCodegen implements CodegenConf
 
     public static final String WRAP_COMPLEX_TYPE = "wrapComplexType";
 
+    public static final String AGGREGATE_MODELS_NAME = "aggregateModelsName";
+
     private final Logger LOGGER = LoggerFactory.getLogger(ProtobufSchemaCodegen.class);
 
     @Setter protected String packageName = "openapitools";
 
+    @Setter protected String aggregateModelsName = null;
+
     private boolean numberedFieldNumberList = false;
 
     private boolean startEnumsWithUnspecified = false;
@@ -186,6 +192,7 @@ public ProtobufSchemaCodegen() {
         addSwitch(START_ENUMS_WITH_UNSPECIFIED, "Introduces \"UNSPECIFIED\" as the first element of enumerations.", startEnumsWithUnspecified);
         addSwitch(ADD_JSON_NAME_ANNOTATION, "Append \"json_name\" annotation to message field when the specification name differs from the protobuf field name", addJsonNameAnnotation);
         addSwitch(WRAP_COMPLEX_TYPE, "Generate Additional message for complex type", wrapComplexType);
+        addOption(AGGREGATE_MODELS_NAME, "Aggregated model filename. If set, all generated models will be combined into this single file.", null);
     }
 
     @Override
@@ -228,6 +235,10 @@ public void processOpts() {
             this.wrapComplexType = convertPropertyToBooleanAndWriteBack(WRAP_COMPLEX_TYPE);
         }
 
+        if (additionalProperties.containsKey(AGGREGATE_MODELS_NAME)) {
+            this.setAggregateModelsName((String) additionalProperties.get(AGGREGATE_MODELS_NAME));
+        }
+
         supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
     }
 
@@ -650,7 +661,35 @@ public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs)
                         .forEach(importFromList -> this.addImport(objs, parentCM, importFromList));
             }
         }
-        return objs;
+        return aggregateModelsName == null ? objs : aggregateModels(objs);
+    }
+
+    /**
+     * Aggregates all individual model definitions into a single entry.
+     *
+     * @param objs the original map of model names to their respective entries
+     * @return a new {@link Map} containing a single entry keyed by {@code aggregateModelsName} with
+     *         combined models and imports from all provided entries
+     */
+    public Map<String, ModelsMap> aggregateModels(Map<String, ModelsMap> objs) {
+        Map<String, ModelsMap> objects = new HashMap<>();
+        ModelsMap aggregateObj = objs.values().stream()
+                .findFirst()
+                .orElse(new ModelsMap());
+
+        List<ModelMap> models = objs.values().stream()
+                .flatMap(modelsMap -> modelsMap.getModels().stream())
+                .collect(Collectors.toList());
+
+        Set<Map<String, String>> imports = objs.values().stream()
+                .flatMap(modelsMap -> modelsMap.getImports().stream())
+                .filter(importMap -> !importMap.get("import").startsWith("models/"))
+                .collect(Collectors.toSet());
+
+        aggregateObj.setModels(models);
+        aggregateObj.setImports(new ArrayList<>(imports));
+        objects.put(this.aggregateModelsName, aggregateObj);
+        return objects;
     }
 
     public void addImport(Map<String, ModelsMap> objs, CodegenModel cm, String importValue) {
@@ -907,6 +946,11 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
             }
         }
 
+        if (this.aggregateModelsName != null) {
+            List<Map<String, String>> aggregate_imports = Collections.singletonList(Collections
+                    .singletonMap(IMPORT, toModelImport(this.aggregateModelsName)));
+            objs.setImports(aggregate_imports);
+        }
         return objs;
     }
 

samples/config/petstore/protobuf-schema-config/.openapi-generator/FILES

@@ -1,15 +1,5 @@
 README.md
-models/api_response.proto
-models/cat.proto
-models/category.proto
-models/dog.proto
-models/order.proto
-models/other_test.proto
-models/pet.proto
-models/pets_get_request.proto
-models/pets_post_request.proto
-models/tag.proto
-models/user.proto
+models/data.proto
 services/default_service.proto
 services/pet_service.proto
 services/store_service.proto

samples/config/petstore/protobuf-schema-config/README.md

@@ -1,4 +1,4 @@
-# gPRC for petstore
+# gPRC for openapitools
 
 This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
 
@@ -17,15 +17,15 @@ Below are some usage examples for Go and Ruby. For other languages, please refer
 ### Go
 ```
 # assuming `protoc-gen-go` has been installed with `go get -u github.com/golang/protobuf/protoc-gen-go`
-mkdir /var/tmp/go/petstore
-protoc --go_out=/var/tmp/go/petstore services/*
-protoc --go_out=/var/tmp/go/petstore models/*
+mkdir /var/tmp/go/openapitools
+protoc --go_out=/var/tmp/go/openapitools services/*
+protoc --go_out=/var/tmp/go/openapitools models/*
 ```
 
 ### Ruby
 ```
 # assuming `grpc_tools_ruby_protoc` has been installed via `gem install grpc-tools`
-RUBY_OUTPUT_DIR="/var/tmp/ruby/petstore"
+RUBY_OUTPUT_DIR="/var/tmp/ruby/openapitools"
 mkdir $RUBY_OUTPUT_DIR
 grpc_tools_ruby_protoc --ruby_out=$RUBY_OUTPUT_DIR --grpc_out=$RUBY_OUTPUT_DIR/lib services/*
 grpc_tools_ruby_protoc --ruby_out=$RUBY_OUTPUT_DIR --grpc_out=$RUBY_OUTPUT_DIR/lib models/*

samples/config/petstore/protobuf-schema-config/models/api_response.proto

@@ -0,0 +1,148 @@
+/*
+  OpenAPI Petstore
+
+  This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+
+  The version of the OpenAPI document: 1.0.0
+
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package openapitools;
+
+import public "google/protobuf/struct.proto";
+
+message ApiResponse {
+
+  int32 code = 1;
+
+  string type = 2;
+
+  string message = 3;
+
+}
+message Cat {
+
+  bool hunts = 1;
+
+  int32 age = 2;
+
+}
+message Category {
+
+  int64 id = 1;
+
+  string name = 2;
+
+}
+message Dog {
+
+  bool bark = 1;
+
+  enum Breed {
+    BREED_UNSPECIFIED = 0;
+    BREED_DINGO = 1;
+    BREED_HUSKY = 2;
+    BREED_RETRIEVER = 3;
+    BREED_SHEPHERD = 4;
+  }
+
+  Breed breed = 2;
+
+}
+message Order {
+
+  int64 id = 1;
+
+  int64 pet_id = 2 [json_name="petId"];
+
+  int32 quantity = 3;
+
+  string ship_date = 4 [json_name="shipDate"];
+
+  // Order Status
+  enum Status {
+    STATUS_UNSPECIFIED = 0;
+    STATUS_PLACED = 1;
+    STATUS_APPROVED = 2;
+    STATUS_DELIVERED = 3;
+  }
+
+  Status status = 5;
+
+  bool complete = 6;
+
+  google.protobuf.Struct meta = 7;
+
+}
+message OtherTest {
+
+  repeated string set_test = 1;
+
+}
+message Pet {
+
+  int64 id = 1;
+
+  Category category = 2;
+
+  string name = 3;
+
+  repeated string photo_urls = 4 [json_name="photoUrls"];
+
+  repeated Tag tags = 5;
+
+  // pet status in the store
+  enum Status {
+    STATUS_UNSPECIFIED = 0;
+    STATUS_AVAILABLE = 1;
+    STATUS_PENDING = 2;
+    STATUS_SOLD = 3;
+  }
+
+  Status status = 6;
+
+}
+message PetsGetRequest {
+
+    oneof pets_get_request {
+        Cat cat = 1;
+        Dog dog = 2;
+    }
+}
+message PetsPostRequest {
+
+  Cat cat = 1;
+
+  Dog dog = 2;
+
+}
+message Tag {
+
+  int64 id = 1;
+
+  string name = 2;
+
+}
+message User {
+
+  int64 id = 1;
+
+  string username = 2;
+
+  string first_name = 3 [json_name="firstName"];
+
+  string last_name = 4 [json_name="lastName"];
+
+  string email = 5;
+
+  string password = 6;
+
+  string phone = 7;
+
+  // User Status
+  int32 user_status = 8 [json_name="userStatus"];
+
+}