Fix generating endpoints by operations with multiple content types. (#…

…1757) See: OpenAPITools/openapi-generator#17877
micronaut-projects · Sep 5, 2024 · 3ec3b29 · 3ec3b29
1 parent 238ac25
commit 3ec3b29
Show file tree

Hide file tree

Showing 12 changed files with 10,980 additions and 1 deletion.
diff --git a/config/checkstyle/custom-suppressions.xml b/config/checkstyle/custom-suppressions.xml
@@ -9,4 +9,5 @@
     <suppress checks="FileLength" files=".*" />
     <suppress checks="ParameterNumber" files=".*" />
     <suppress checks="." files="io[\\/]micronaut[\\/]openapi[\\/]adoc[\\/]md" />
+    <suppress checks="." files="org[\\/]openapitools[\\/]codegen[\\/]" />
 </suppressions>
diff --git a/openapi-generator/build.gradle b/openapi-generator/build.gradle
@@ -11,7 +11,9 @@ dependencies {
             because("OpenAPI generator depends on older release which isn't compatible with SnakeYAML")
         }
     }
-    api libs.openapi.generator
+    api(libs.openapi.generator) {
+        exclude group: "org.projectlombok"
+    }
     api libs.commons.codec
     api libs.managed.evo.inflector
 

diff --git a/...-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java b/...-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java
@@ -41,6 +41,7 @@
 import org.openapitools.codegen.CodegenParameter;
 import org.openapitools.codegen.CodegenProperty;
 import org.openapitools.codegen.SupportingFile;
+import org.openapitools.codegen.config.GlobalSettings;
 import org.openapitools.codegen.languages.AbstractJavaCodegen;
 import org.openapitools.codegen.languages.features.BeanValidationFeatures;
 import org.openapitools.codegen.languages.features.OptionalFeatures;
@@ -75,6 +76,7 @@
 import java.util.stream.Collectors;
 
 import static io.micronaut.openapi.generator.Utils.DEFAULT_BODY_PARAM_NAME;
+import static io.micronaut.openapi.generator.Utils.DIVIDE_OPERATIONS_BY_CONTENT_TYPE;
 import static io.micronaut.openapi.generator.Utils.EXT_ANNOTATIONS_CLASS;
 import static io.micronaut.openapi.generator.Utils.EXT_ANNOTATIONS_FIELD;
 import static io.micronaut.openapi.generator.Utils.EXT_ANNOTATIONS_OPERATION;
@@ -186,6 +188,8 @@ protected AbstractMicronautJavaCodegen() {
         inlineSchemaOption.put("RESOLVE_INLINE_ENUMS", "true");
         // CHECKSTYLE:ON
 
+        GlobalSettings.setProperty(DIVIDE_OPERATIONS_BY_CONTENT_TYPE, "true");
+
         // Set implemented features for user information
         modifyFeatureSet(features -> features
             .includeDocumentationFeatures(

diff --git a/...enerator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautKotlinCodegen.java b/...enerator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautKotlinCodegen.java
@@ -44,6 +44,7 @@
 import org.openapitools.codegen.CodegenProperty;
 import org.openapitools.codegen.DefaultCodegen;
 import org.openapitools.codegen.SupportingFile;
+import org.openapitools.codegen.config.GlobalSettings;
 import org.openapitools.codegen.languages.AbstractKotlinCodegen;
 import org.openapitools.codegen.languages.features.BeanValidationFeatures;
 import org.openapitools.codegen.meta.features.ClientModificationFeature;
@@ -78,6 +79,7 @@
 import java.util.stream.Collectors;
 
 import static io.micronaut.openapi.generator.Utils.DEFAULT_BODY_PARAM_NAME;
+import static io.micronaut.openapi.generator.Utils.DIVIDE_OPERATIONS_BY_CONTENT_TYPE;
 import static io.micronaut.openapi.generator.Utils.EXT_ANNOTATIONS_CLASS;
 import static io.micronaut.openapi.generator.Utils.EXT_ANNOTATIONS_FIELD;
 import static io.micronaut.openapi.generator.Utils.EXT_ANNOTATIONS_OPERATION;
@@ -237,6 +239,8 @@ protected AbstractMicronautKotlinCodegen() {
         useOneOfInterfaces = true;
         // CHECKSTYLE:ON
 
+        GlobalSettings.setProperty(DIVIDE_OPERATIONS_BY_CONTENT_TYPE, "true");
+
         // Set implemented features for user information
         modifyFeatureSet(features -> features
             .wireFormatFeatures(EnumSet.of(WireFormatFeature.JSON, WireFormatFeature.XML))

diff --git a/openapi-generator/src/main/java/io/micronaut/openapi/generator/Utils.java b/openapi-generator/src/main/java/io/micronaut/openapi/generator/Utils.java
@@ -48,6 +48,8 @@ public final class Utils {
         "LocalDate",
         "LocalTime"
     );
+    public static final String DIVIDE_OPERATIONS_BY_CONTENT_TYPE = "divideOperationsByContentType";
+
     public static final String DEFAULT_BODY_PARAM_NAME = "requestBody";
     public static final String EXT_ANNOTATIONS_OPERATION = "x-operation-extra-annotation";
     public static final String EXT_ANNOTATIONS_CLASS = "x-class-extra-annotation";

diff --git a/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java b/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
diff --git a/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java b/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
diff --git a/...enerator/src/test/java/io/micronaut/openapi/generator/JavaMicronautClientCodegenTest.java b/...enerator/src/test/java/io/micronaut/openapi/generator/JavaMicronautClientCodegenTest.java
@@ -748,4 +748,27 @@ public FileCreateDto(String typeCode, String orgName) {
                     }
                 """);
     }
+
+    @Test
+    void testMultipleContentTypesEndpoints() {
+
+        var codegen = new JavaMicronautClientCodegen();
+        String outputPath = generateFiles(codegen, "src/test/resources/3_0/multiple-content-types.yml", CodegenConstants.APIS, CodegenConstants.MODELS);
+        String path = outputPath + "src/main/java/org/openapitools/";
+
+        assertFileContains(path + "api/DefaultApi.java", """
+                    @Post("/multiplecontentpath")
+                    Mono<HttpResponse<Void>> myOp(
+                        @Body @Nullable @Valid Coordinates coordinates
+                    );
+                """,
+            """
+                    @Post("/multiplecontentpath")
+                    @Produces("multipart/form-data")
+                    Mono<HttpResponse<Void>> myOp_1(
+                        @Nullable @Valid Coordinates coordinates,
+                        @Nullable byte[] file
+                    );
+                """);
+    }
 }
diff --git a/...enerator/src/test/java/io/micronaut/openapi/generator/JavaMicronautServerCodegenTest.java b/...enerator/src/test/java/io/micronaut/openapi/generator/JavaMicronautServerCodegenTest.java
@@ -528,4 +528,37 @@ void testMultipartFormData() {
                 );
             """);
     }
+
+    @Test
+    void testMultipleContentTypesEndpoints() {
+
+        var codegen = new JavaMicronautServerCodegen();
+        String outputPath = generateFiles(codegen, "src/test/resources/3_0/multiple-content-types.yml", CodegenConstants.APIS, CodegenConstants.MODELS);
+        String path = outputPath + "src/main/java/org/openapitools/";
+
+        assertFileContains(path + "api/DefaultApi.java", """
+                    @Operation(
+                        operationId = "myOp",
+                        responses = @ApiResponse(responseCode = "201", description = "Successfully created")
+                    )
+                    @Post("/multiplecontentpath")
+                    @Secured(SecurityRule.IS_ANONYMOUS)
+                    Mono<HttpResponse<Void>> myOp(
+                        @Body @Nullable(inherited = true) @Valid Coordinates coordinates
+                    );
+                """,
+            """
+                    @Operation(
+                        operationId = "myOp_0",
+                        responses = @ApiResponse(responseCode = "201", description = "Successfully created")
+                    )
+                    @Post("/multiplecontentpath")
+                    @Consumes("multipart/form-data")
+                    @Secured(SecurityRule.IS_ANONYMOUS)
+                    Mono<HttpResponse<Void>> myOp_1(
+                        @Nullable(inherited = true) @Valid Coordinates coordinates,
+                        @Nullable(inherited = true) CompletedFileUpload file
+                    );
+                """);
+    }
 }
diff --git a/...erator/src/test/java/io/micronaut/openapi/generator/KotlinMicronautClientCodegenTest.java b/...erator/src/test/java/io/micronaut/openapi/generator/KotlinMicronautClientCodegenTest.java
@@ -779,4 +779,27 @@ data class FileCreateDto(
                 ) {
                 """);
     }
+
+    @Test
+    void testMultipleContentTypesEndpoints() {
+
+        var codegen = new KotlinMicronautClientCodegen();
+        String outputPath = generateFiles(codegen, "src/test/resources/3_0/multiple-content-types.yml", CodegenConstants.APIS, CodegenConstants.MODELS);
+        String path = outputPath + "src/main/kotlin/org/openapitools/";
+
+        assertFileContains(path + "api/DefaultApi.kt", """
+                    @Post("/multiplecontentpath")
+                    fun myOp(
+                        @Body @Nullable @Valid coordinates: Coordinates?
+                    ): Mono<HttpResponse<Void>>
+                """,
+            """
+                    @Post("/multiplecontentpath")
+                    @Produces("multipart/form-data")
+                    fun myOp_1(
+                        @Nullable @Valid coordinates: Coordinates?,
+                        @Nullable file: ByteArray?
+                    ): Mono<HttpResponse<Void>>
+                """);
+    }
 }
diff --git a/...erator/src/test/java/io/micronaut/openapi/generator/KotlinMicronautServerCodegenTest.java b/...erator/src/test/java/io/micronaut/openapi/generator/KotlinMicronautServerCodegenTest.java
@@ -613,4 +613,41 @@ fun profilePasswordPost(
                 ): Mono<SuccessResetPassword>
             """);
     }
+
+    @Test
+    void testMultipleContentTypesEndpoints() {
+
+        var codegen = new KotlinMicronautServerCodegen();
+        String outputPath = generateFiles(codegen, "src/test/resources/3_0/multiple-content-types.yml", CodegenConstants.APIS, CodegenConstants.MODELS);
+        String path = outputPath + "src/main/kotlin/org/openapitools/";
+
+        assertFileContains(path + "api/DefaultApi.kt", """
+                    @Operation(
+                        operationId = "myOp",
+                        responses = [
+                            ApiResponse(responseCode = "201", description = "Successfully created")
+                        ]
+                    )
+                    @Post("/multiplecontentpath")
+                    @Secured(SecurityRule.IS_ANONYMOUS)
+                    fun myOp(
+                        @Body @Nullable @Valid coordinates: Coordinates?
+                    ): Mono<HttpResponse<Void>>
+                """,
+            """
+                    @Operation(
+                        operationId = "myOp_0",
+                        responses = [
+                            ApiResponse(responseCode = "201", description = "Successfully created")
+                        ]
+                    )
+                    @Post("/multiplecontentpath")
+                    @Consumes("multipart/form-data")
+                    @Secured(SecurityRule.IS_ANONYMOUS)
+                    fun myOp_1(
+                        @Nullable @Valid coordinates: Coordinates?,
+                        @Nullable file: CompletedFileUpload?
+                    ): Mono<HttpResponse<Void>>
+                """);
+    }
 }
diff --git a/openapi-generator/src/test/resources/3_0/multiple-content-types.yml b/openapi-generator/src/test/resources/3_0/multiple-content-types.yml
@@ -0,0 +1,41 @@
+openapi: 3.0.3
+info:
+  version: "1"
+  title: Multiple Content Types for same request
+paths:
+  /multiplecontentpath:
+    post:
+      operationId: myOp
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/coordinates'
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                coordinates:
+                  $ref: '#/components/schemas/coordinates'
+                file:
+                  type: string
+                  format: binary
+      responses:
+        201:
+          description: Successfully created
+          headers:
+            Location:
+              schema:
+                type: string
+components:
+  schemas:
+    coordinates:
+      type: object
+      required:
+        - lat
+        - long
+      properties:
+        lat:
+          type: number
+        long:
+          type: number