336 fix responses with no body return void (#337)

* Fix responses with no body and add test to check for no content * Update version to 5.3.6 * Change scs-multiapi-maven-plugin lombok version * Add developer information * Resolve conflicts in README.md
sngular · Apr 1, 2024 · e5dbf2c · e5dbf2c
1 parent fe2c468
commit e5dbf2c
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ As commented above, they both could be used at the same time, setting a double
 <plugin>
   <groupId>com.sngular</groupId>
   <artifactId>scs-multiapi-maven-plugin</artifactId>
-  <version>5.4.0</version>
+  <version>5.4.1</version>
   <executions>
     <execution>
       <id>asyncapi</id>
@@ -114,7 +114,7 @@ Apply the plugin in the `build.gradle` file and invoke the task.
 ```groovy
 plugins {
   id "java"
-  id "com.sngular.scs-multiapi-gradle-plugin' version '5.4.0"
+  id "com.sngular.scs-multiapi-gradle-plugin' version '5.4.1"
 
   openapimodel {
 
@@ -153,7 +153,7 @@ which the plugin is designed.
 <plugin>
   <groupId>com.sngular</groupId>
   <artifactId>scs-multiapi-maven-plugin</artifactId>
-  <version>5.4.0</version>
+  <version>5.4.1</version>
   <executions>
     <execution>
       <phase>generate-sources</phase>
@@ -584,7 +584,7 @@ file. Here is an example of a basic configuration:
 <plugin>
   <groupId>com.sngular</groupId>
   <artifactId>scs-multiapi-maven-plugin</artifactId>
-  <version>5.4.0</version>
+  <version>5.4.1</version>
   <executions>
     <execution>
       <goals>

diff --git a/multiapi-engine/pom.xml b/multiapi-engine/pom.xml
@@ -4,7 +4,7 @@
 
   <groupId>com.sngular</groupId>
   <artifactId>multiapi-engine</artifactId>
-  <version>5.4.0</version>
+  <version>5.4.1</version>
   <packaging>jar</packaging>
 
   <properties>

diff --git a/multiapi-engine/src/main/resources/templates/openapi/templateCallRestClient.ftlh b/multiapi-engine/src/main/resources/templates/openapi/templateCallRestClient.ftlh
@@ -107,8 +107,8 @@ public class ${className?cap_first}Api {
    */
   public <@compress single_line=true><#if operation.responseObjects[0].contentObjects[0]??>
     ${operation.responseObjects[0].contentObjects[0].dataType}
-    <#else>Void</#if></@compress> ${operation.operationId}<#compress>(<#if operation.parameterObjects?has_content><#list operation.parameterObjects as parameter>${parameter.dataType} ${parameter.name}<#if parameter?has_next || operation.requestObjects?has_content>, </#if></#list></#if><#if path.parameterObjects?has_content><#list path.parameterObjects as parameter>${parameter.dataType} ${parameter.name}<#if parameter?has_next || operation.requestObjects?has_content>, </#if></#list></#if><#if operation.requestObjects?has_content><#list operation.requestObjects as request><#list request.contentObjects as content>${content.dataType} ${content.dataType?api.getVariableNameString()} <#if content?has_next>, </#if></#list></#list></#if>)</#compress> throws RestClientException {
-    return ${operation.operationId}WithHttpInfo(<#compress><#if operation.parameterObjects?has_content><#list operation.parameterObjects as parameter>${parameter.name}<#if parameter?has_next || operation.requestObjects?has_content>, </#if></#list></#if><#if path.parameterObjects?has_content><#list path.parameterObjects as parameter>${parameter.name}<#if parameter?has_next || operation.requestObjects?has_content>, </#if></#list></#if><#if operation.requestObjects?has_content><#list operation.requestObjects as request><#list request.contentObjects as content>${content.dataType?api.getVariableNameString()}<#if content?has_next>, </#if></#list></#list></#if>)<#if operation.responseObjects[0].contentObjects[0]??>.getBody()</#if>;</#compress>
+    <#else>void</#if></@compress> ${operation.operationId}<#compress>(<#if operation.parameterObjects?has_content><#list operation.parameterObjects as parameter>${parameter.dataType} ${parameter.name}<#if parameter?has_next || operation.requestObjects?has_content>, </#if></#list></#if><#if path.parameterObjects?has_content><#list path.parameterObjects as parameter>${parameter.dataType} ${parameter.name}<#if parameter?has_next || operation.requestObjects?has_content>, </#if></#list></#if><#if operation.requestObjects?has_content><#list operation.requestObjects as request><#list request.contentObjects as content>${content.dataType} ${content.dataType?api.getVariableNameString()} <#if content?has_next>, </#if></#list></#list></#if>)</#compress> throws RestClientException {
+    <#if operation.responseObjects[0].contentObjects[0]??>return </#if>${operation.operationId}WithHttpInfo(<#compress><#if operation.parameterObjects?has_content><#list operation.parameterObjects as parameter>${parameter.name}<#if parameter?has_next || operation.requestObjects?has_content>, </#if></#list></#if><#if path.parameterObjects?has_content><#list path.parameterObjects as parameter>${parameter.name}<#if parameter?has_next || operation.requestObjects?has_content>, </#if></#list></#if><#if operation.requestObjects?has_content><#list operation.requestObjects as request><#list request.contentObjects as content>${content.dataType?api.getVariableNameString()}<#if content?has_next>, </#if></#list></#list></#if>)<#if operation.responseObjects[0].contentObjects[0]??>.getBody()</#if>;</#compress>
   }
 
   public <@compress single_line=true><#if operation.responseObjects[0].contentObjects[0]??>

diff --git a/...gine/src/test/java/com/sngular/api/generator/plugin/openapi/OpenApiGeneratorFixtures.java b/...gine/src/test/java/com/sngular/api/generator/plugin/openapi/OpenApiGeneratorFixtures.java
@@ -199,7 +199,7 @@ public final class OpenApiGeneratorFixtures {
   static final List<SpecFile> TEST_REST_CLIENT_GENERATION = List.of(
       SpecFile
           .builder()
-          .filePath("openapigenerator/testClientPackageWebClientApiGeneration/api-test.yml")
+          .filePath("openapigenerator/testRestClientApiGeneration/api-test.yml")
           .apiPackage("com.sngular.multifileplugin.restclient")
           .modelPackage("com.sngular.multifileplugin.restclient.model")
           .clientPackage("com.sngular.multifileplugin.restclient.client")

diff --git a/multiapi-engine/src/test/resources/openapigenerator/testRestClientApiGeneration/api-test.yml b/multiapi-engine/src/test/resources/openapigenerator/testRestClientApiGeneration/api-test.yml
@@ -61,6 +61,28 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Error"
+    delete:
+      summary: Info for a specific test
+      operationId: deleteTestById
+      tags:
+        - test
+      parameters:
+        - name: testId
+          in: path
+          required: true
+          description: The id of the test to retrieve
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '204':
+          description: No content response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
 security:
   - BasicAuth: []
 components:

diff --git a/...ngine/src/test/resources/openapigenerator/testRestClientApiGeneration/assets/TestApi.java b/...ngine/src/test/resources/openapigenerator/testRestClientApiGeneration/assets/TestApi.java
@@ -104,4 +104,36 @@ public ResponseEntity<ApiTestInfoDTO> showTestByIdWithHttpInfo(Integer testId) t
     return apiRestClient.invokeAPI("http://localhost:8080/v1","/test/{testId}", HttpMethod.GET, uriVariables, queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
   }
 
+  /**
+   * DELETE /test/{testId}: Info for a specific test
+   * @param testId The id of the test to retrieve true
+   * @return No content response; (status code 204)
+   * @throws RestClientException if an error occurs while attempting to invoke the API
+   */
+  public void deleteTestById(Integer testId) throws RestClientException {
+    deleteTestByIdWithHttpInfo(testId);
+  }
+
+  public ResponseEntity<Void> deleteTestByIdWithHttpInfo(Integer testId) throws RestClientException {
+
+    Object postBody = null;
+    final Map<String, Object> uriVariables = new HashMap<String, Object>();
+
+    uriVariables.put("testId",  testId);
+    final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<String, String>();
+    final HttpHeaders headerParams = new HttpHeaders();
+    final MultiValueMap<String, String> cookieParams = new LinkedMultiValueMap<String, String>();
+    final MultiValueMap<String, Object> formParams = new LinkedMultiValueMap<String, Object>();
+
+    final String[] localVarAccepts = {"application/json"};
+    final List<MediaType> localVarAccept = apiRestClient.selectHeaderAccept(localVarAccepts);
+    final String[] localVarContentTypes = {};
+    final MediaType localVarContentType = apiRestClient.selectHeaderContentType(localVarContentTypes);
+
+    String[] localVarAuthNames = new String[] {"BasicAuth"};
+
+    ParameterizedTypeReference<Void> localVarReturnType = new ParameterizedTypeReference<Void>() {};
+    return apiRestClient.invokeAPI("http://localhost:8080/v1","/test/{testId}", HttpMethod.DELETE, uriVariables, queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
+  }
+
 }
diff --git a/scs-multiapi-gradle-plugin/build.gradle b/scs-multiapi-gradle-plugin/build.gradle
@@ -20,7 +20,7 @@ repositories {
 }
 
 group = 'com.sngular'
-version = '5.4.0'
+version = '5.4.1'
 
 def SCSMultiApiPluginGroupId = group
 def SCSMultiApiPluginVersion = version
@@ -30,7 +30,7 @@ dependencies {
   shadow localGroovy()
   shadow gradleApi()
 
-  implementation 'com.sngular:multiapi-engine:5.4.0'
+  implementation 'com.sngular:multiapi-engine:5.4.1'
   testImplementation 'org.assertj:assertj-core:3.24.2'
   testImplementation 'com.puppycrawl.tools:checkstyle:10.12.3'
 }
@@ -98,7 +98,7 @@ testing {
 
     integrationTest(JvmTestSuite) {
       dependencies {
-        implementation 'com.sngular:scs-multiapi-gradle-plugin:5.4.0'
+        implementation 'com.sngular:scs-multiapi-gradle-plugin:5.4.1'
         implementation 'org.assertj:assertj-core:3.24.2'
       }
 

diff --git a/scs-multiapi-maven-plugin/pom.xml b/scs-multiapi-maven-plugin/pom.xml
@@ -4,7 +4,7 @@
 
   <groupId>com.sngular</groupId>
   <artifactId>scs-multiapi-maven-plugin</artifactId>
-  <version>5.4.0</version>
+  <version>5.4.1</version>
   <packaging>maven-plugin</packaging>
 
   <name>AsyncApi - OpenApi Code Generator Maven Plugin</name>
@@ -196,6 +196,12 @@
       </roles>
       <timezone>Europe/Madrid</timezone>
     </developer>
+    <developer>
+      <id>carlosaf-sngular</id>
+      <name>Carlos Alonso Ferreira</name>
+      <email>[email protected]</email>
+      <organizationUrl>https://sngular.github.io/</organizationUrl>
+    </developer>
     <developer>
       <id>MarcosFreireSngular</id>
       <name>Marcos Freire Patiño</name>
@@ -254,7 +260,7 @@
     <dependency>
       <groupId>com.sngular</groupId>
       <artifactId>multiapi-engine</artifactId>
-      <version>5.4.0</version>
+      <version>5.4.1</version>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>