Merge pull request #714 from swagger-api/parameters-order

gracekarina · web-flow · commit d8e6554909b4 · 2020-06-30T16:21:45.000-05:00
fix and test for parameter order issue in spring generator
diff --git a/src/main/java/io/swagger/codegen/v3/generators/DefaultCodegenConfig.java b/src/main/java/io/swagger/codegen/v3/generators/DefaultCodegenConfig.java
@@ -2165,8 +2165,6 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
                                 requiredParams.add(formParameter.copy());
                             }
                             allParams.add(formParameter);
-
-                            codegenContent.getParameters().add(formParameter.copy());
                         }
                         codegenContents.add(codegenContent);
                     }
@@ -2188,7 +2186,6 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
                         }
                     }
                     foundSchemas.add(schema);
-                    codegenContent.getParameters().add(bodyParam.copy());
                     codegenContents.add(codegenContent);
                 }
             }
@@ -4282,7 +4279,7 @@ protected void configuresParameterForMediaType(CodegenOperation codegenOperation
             codegenOperation.getContents().add(content);
             return;
         }
-        this.addCodegenContentParemeters(codegenOperation, codegenContents);
+        this.addCodegenContentParameters(codegenOperation, codegenContents);
         for (CodegenContent content : codegenContents) {
             if (ensureUniqueParams) {
                 ensureUniqueParameters(content.getParameters());
@@ -4304,7 +4301,7 @@ protected void configuresParameterForMediaType(CodegenOperation codegenOperation
         codegenOperation.getContents().addAll(codegenContents);
     }
 
-    protected void addParemeters(CodegenContent codegenContent, List<CodegenParameter> codegenParameters) {
+    protected void addParameters(CodegenContent codegenContent, List<CodegenParameter> codegenParameters) {
         if (codegenParameters == null || codegenParameters.isEmpty()) {
             return;
         }
@@ -4313,12 +4310,13 @@ protected void addParemeters(CodegenContent codegenContent, List<CodegenParamete
         }
     }
 
-    protected void addCodegenContentParemeters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {
+    protected void addCodegenContentParameters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {
         for (CodegenContent content : codegenContents) {
-            addParemeters(content, codegenOperation.headerParams);
-            addParemeters(content, codegenOperation.queryParams);
-            addParemeters(content, codegenOperation.pathParams);
-            addParemeters(content, codegenOperation.cookieParams);
+            addParameters(content, codegenOperation.bodyParams);
+            addParameters(content, codegenOperation.headerParams);
+            addParameters(content, codegenOperation.queryParams);
+            addParameters(content, codegenOperation.pathParams);
+            addParameters(content, codegenOperation.cookieParams);
         }
     }
 
diff --git a/src/main/java/io/swagger/codegen/v3/generators/dotnet/AbstractCSharpCodegen.java b/src/main/java/io/swagger/codegen/v3/generators/dotnet/AbstractCSharpCodegen.java
@@ -1073,11 +1073,12 @@ public void addHandlebarHelpers(Handlebars handlebars) {
     }
 
     @Override
-    protected void addCodegenContentParemeters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {
+    protected void addCodegenContentParameters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {
         for (CodegenContent content : codegenContents) {
-            addParemeters(content, codegenOperation.headerParams);
-            addParemeters(content, codegenOperation.queryParams);
-            addParemeters(content, codegenOperation.pathParams);
+            addParameters(content, codegenOperation.bodyParams);
+            addParameters(content, codegenOperation.headerParams);
+            addParameters(content, codegenOperation.queryParams);
+            addParameters(content, codegenOperation.pathParams);
         }
     }
 /*
diff --git a/src/main/java/io/swagger/codegen/v3/generators/java/SpringCodegen.java b/src/main/java/io/swagger/codegen/v3/generators/java/SpringCodegen.java
@@ -133,6 +133,17 @@ public SpringCodegen() {
 
     }
 
+    @Override
+    protected void addCodegenContentParameters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {
+        for (CodegenContent content : codegenContents) {
+            addParameters(content, codegenOperation.headerParams);
+            addParameters(content, codegenOperation.queryParams);
+            addParameters(content, codegenOperation.pathParams);
+            addParameters(content, codegenOperation.cookieParams);
+            addParameters(content, codegenOperation.bodyParams);
+        }
+    }
+
     @Override
     public CodegenType getTag() {
         return CodegenType.SERVER;
diff --git a/src/main/java/io/swagger/codegen/v3/generators/nodejs/NodeJSServerCodegen.java b/src/main/java/io/swagger/codegen/v3/generators/nodejs/NodeJSServerCodegen.java
@@ -445,10 +445,11 @@ protected void configuresParameterForMediaType(CodegenOperation codegenOperation
             return;
         }
         for (CodegenContent content : codegenContents) {
-            addParemeters(content, codegenOperation.queryParams);
-            addParemeters(content, codegenOperation.pathParams);
-            addParemeters(content, codegenOperation.headerParams);
-            addParemeters(content, codegenOperation.cookieParams);
+            addParameters(content, codegenOperation.bodyParams);
+            addParameters(content, codegenOperation.queryParams);
+            addParameters(content, codegenOperation.pathParams);
+            addParameters(content, codegenOperation.headerParams);
+            addParameters(content, codegenOperation.cookieParams);
         }
         for (CodegenContent content : codegenContents) {
             addHasMore(content.getParameters());
diff --git a/src/test/java/io/swagger/codegen/v3/generators/java/SpringGeneratorCodegenTest.java b/src/test/java/io/swagger/codegen/v3/generators/java/SpringGeneratorCodegenTest.java
@@ -0,0 +1,43 @@
+package io.swagger.codegen.v3.generators.java;
+
+import io.swagger.codegen.v3.ClientOptInput;
+import io.swagger.codegen.v3.DefaultGenerator;
+import io.swagger.codegen.v3.config.CodegenConfigurator;
+import io.swagger.codegen.v3.generators.AbstractCodegenTest;
+import org.apache.commons.io.FileUtils;
+import org.junit.rules.TemporaryFolder;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+
+import java.io.File;
+
+public class SpringGeneratorCodegenTest extends AbstractCodegenTest {
+
+    private TemporaryFolder folder = new TemporaryFolder();
+
+    @Test(description = "verify that parameters are listed in following order: header, query, path, cookie, body")
+    public void testParameterOrders() throws Exception {
+        this.folder.create();
+        final File output = this.folder.getRoot();
+
+        final CodegenConfigurator configurator = new CodegenConfigurator()
+            .setLang("spring")
+            .setInputSpecURL("src/test/resources/3_0_0/parameterOrder.yaml")
+            .setOutputDir(output.getAbsolutePath());
+
+        final ClientOptInput clientOptInput = configurator.toClientOptInput();
+        new DefaultGenerator().opts(clientOptInput).generate();
+
+        final File petControllerFile = new File(output, "/src/main/java/io/swagger/api/AdminApi.java");
+        final String content = FileUtils.readFileToString(petControllerFile);
+
+
+        Assert.assertTrue(content.contains("ResponseEntity<LocalizedText> updateTest(@ApiParam(value = \"description\",required=true) @PathVariable(\"id\") Long id\n" +
+            ",@ApiParam(value = \"Localized Text object containing updated data.\" ,required=true )  @Valid @RequestBody LocalizedText body\n" +
+            ");"));
+
+        this.folder.delete();
+    }
+
+
+}
diff --git a/src/test/resources/3_0_0/parameterOrder.yaml b/src/test/resources/3_0_0/parameterOrder.yaml

Original file line number	Diff line number	Diff line change
`@@ -2165,8 +2165,6 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation`
`2165`	`2165`	`requiredParams.add(formParameter.copy());`
`2166`	`2166`	`}`
`2167`	`2167`	`allParams.add(formParameter);`
`2168`		`-`
`2169`		`- codegenContent.getParameters().add(formParameter.copy());`
`2170`	`2168`	`}`
`2171`	`2169`	`codegenContents.add(codegenContent);`
`2172`	`2170`	`}`
`@@ -2188,7 +2186,6 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation`
`2188`	`2186`	`}`
`2189`	`2187`	`}`
`2190`	`2188`	`foundSchemas.add(schema);`
`2191`		`- codegenContent.getParameters().add(bodyParam.copy());`
`2192`	`2189`	`codegenContents.add(codegenContent);`
`2193`	`2190`	`}`
`2194`	`2191`	`}`
`@@ -4282,7 +4279,7 @@ protected void configuresParameterForMediaType(CodegenOperation codegenOperation`
`4282`	`4279`	`codegenOperation.getContents().add(content);`
`4283`	`4280`	`return;`
`4284`	`4281`	`}`
`4285`		`- this.addCodegenContentParemeters(codegenOperation, codegenContents);`
	`4282`	`+ this.addCodegenContentParameters(codegenOperation, codegenContents);`
`4286`	`4283`	`for (CodegenContent content : codegenContents) {`
`4287`	`4284`	`if (ensureUniqueParams) {`
`4288`	`4285`	`ensureUniqueParameters(content.getParameters());`
`@@ -4304,7 +4301,7 @@ protected void configuresParameterForMediaType(CodegenOperation codegenOperation`
`4304`	`4301`	`codegenOperation.getContents().addAll(codegenContents);`
`4305`	`4302`	`}`
`4306`	`4303`
`4307`		`- protected void addParemeters(CodegenContent codegenContent, List<CodegenParameter> codegenParameters) {`
	`4304`	`+ protected void addParameters(CodegenContent codegenContent, List<CodegenParameter> codegenParameters) {`
`4308`	`4305`	`if (codegenParameters == null \|\| codegenParameters.isEmpty()) {`
`4309`	`4306`	`return;`
`4310`	`4307`	`}`
`@@ -4313,12 +4310,13 @@ protected void addParemeters(CodegenContent codegenContent, List<CodegenParamete`
`4313`	`4310`	`}`
`4314`	`4311`	`}`
`4315`	`4312`
`4316`		`- protected void addCodegenContentParemeters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {`
	`4313`	`+ protected void addCodegenContentParameters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {`
`4317`	`4314`	`for (CodegenContent content : codegenContents) {`
`4318`		`- addParemeters(content, codegenOperation.headerParams);`
`4319`		`- addParemeters(content, codegenOperation.queryParams);`
`4320`		`- addParemeters(content, codegenOperation.pathParams);`
`4321`		`- addParemeters(content, codegenOperation.cookieParams);`
	`4315`	`+ addParameters(content, codegenOperation.bodyParams);`
	`4316`	`+ addParameters(content, codegenOperation.headerParams);`
	`4317`	`+ addParameters(content, codegenOperation.queryParams);`
	`4318`	`+ addParameters(content, codegenOperation.pathParams);`
	`4319`	`+ addParameters(content, codegenOperation.cookieParams);`
`4322`	`4320`	`}`
`4323`	`4321`	`}`
`4324`	`4322`
Original file line number	Diff line number	Diff line change
`@@ -1073,11 +1073,12 @@ public void addHandlebarHelpers(Handlebars handlebars) {`
`1073`	`1073`	`}`
`1074`	`1074`
`1075`	`1075`	`@Override`
`1076`		`- protected void addCodegenContentParemeters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {`
	`1076`	`+ protected void addCodegenContentParameters(CodegenOperation codegenOperation, List<CodegenContent> codegenContents) {`
`1077`	`1077`	`for (CodegenContent content : codegenContents) {`
`1078`		`- addParemeters(content, codegenOperation.headerParams);`
`1079`		`- addParemeters(content, codegenOperation.queryParams);`
`1080`		`- addParemeters(content, codegenOperation.pathParams);`
	`1078`	`+ addParameters(content, codegenOperation.bodyParams);`
	`1079`	`+ addParameters(content, codegenOperation.headerParams);`
	`1080`	`+ addParameters(content, codegenOperation.queryParams);`
	`1081`	`+ addParameters(content, codegenOperation.pathParams);`
`1081`	`1082`	`}`
`1082`	`1083`	`}`
`1083`	`1084`	`/*`