Use postman notation (#17028)

* use Postman notation for path parameter * Regenerate samples
OpenAPITools · Nov 11, 2023 · 09060c6 · 09060c6
1 parent 279a92c
commit 09060c6
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 10 deletions.
diff --git a/...-generator/src/main/java/org/openapitools/codegen/languages/PostmanCollectionCodegen.java b/...-generator/src/main/java/org/openapitools/codegen/languages/PostmanCollectionCodegen.java
@@ -131,6 +131,7 @@ public PostmanCollectionCodegen() {
 
     @Override
     public void postProcessParameter(CodegenParameter parameter) {
+        // create Postman variable from every path parameter
         if(pathParamsAsVariables && parameter.isPathParam) {
             variables.add(new PostmanVariable()
                     .addName(parameter.paramName)
@@ -216,13 +217,16 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
 
         for(CodegenOperation codegenOperation : opList) {
 
+            // use Postman notation for path parameter
+            codegenOperation.path = replacesBracesInPath(codegenOperation.path);
+
             if(pathParamsAsVariables) {
-                // create Postman variable from path parameter
-                codegenOperation.path = doubleCurlyBraces(codegenOperation.path);
-            } else {
-                // use Postman notation for path parameter
-                codegenOperation.path = replacesBracesInPath(codegenOperation.path);
+                // set value of path parameter with corresponding env variable
+                for(CodegenParameter codegenParameter : codegenOperation.pathParams) {
+                    codegenParameter.defaultValue = "{{" + codegenParameter.paramName + "}}";
+                }
             }
+
             codegenOperation.summary = getSummary(codegenOperation);
 
             // request headers

diff --git a/modules/openapi-generator/src/main/resources/postman-collection/item.mustache b/modules/openapi-generator/src/main/resources/postman-collection/item.mustache
@@ -39,7 +39,7 @@
                                             {{#pathParams}}
                                             {
                                                 "key": "{{paramName}}",
-                                                "value": "",
+                                                "value": "{{defaultValue}}",
                                                 "description": "{{description}}"
                                             }{{^-last}},{{/-last}}
                                         {{/pathParams}}

diff --git a/...enerator/src/test/java/org/openapitools/codegen/postman/PostmanCollectionCodegenTest.java b/...enerator/src/test/java/org/openapitools/codegen/postman/PostmanCollectionCodegenTest.java
@@ -161,7 +161,9 @@ public void testVariables() throws Exception {
                 "key\": \"groupId\", \"value\": \"1\", \"type\": \"number\"");
 
         // verify request endpoint
-        TestUtils.assertFileContains(path, "\"name\": \"/users/{{userId}}\"");
+        TestUtils.assertFileContains(path, "\"name\": \"/users/:userId\"");
+        // verify path parameter value
+        TestUtils.assertFileContains(path, "key\": \"userId\", \"value\": \"{{userId}}\",");
 
     }
 
@@ -196,7 +198,9 @@ public void testVariablesInRequestExample() throws Exception {
         assertFileContains(path, "{{MY_VAR_NAME}}");
 
         // verify request endpoint
-        TestUtils.assertFileContains(path, "\"name\": \"/users/{{userId}}\"");
+        TestUtils.assertFileContains(path, "\"name\": \"/users/:userId\"");
+        // verify path parameter value
+        TestUtils.assertFileContains(path, "key\": \"userId\", \"value\": \"{{userId}}\",");
 
     }
 
@@ -303,7 +307,10 @@ public void testNamingRequestsWithUrl() throws Exception {
         Path path = Paths.get(output + "/postman.json");
         assertFileExists(path);
         // verify request name (from path)
-        assertFileContains(path, "\"name\": \"/users/{{userId}}\"");
+        assertFileContains(path, "\"name\": \"/users/:userId\"");
+        // verify path parameter value
+        TestUtils.assertFileContains(path, "key\": \"userId\", \"value\": \"{{userId}}\",");
+
     }
 
     @Test

diff --git a/samples/schema/postman-collection/postman.json b/samples/schema/postman-collection/postman.json
@@ -116,7 +116,7 @@
                                         "variable": [
                                             {
                                                 "key": "groupId",
-                                                "value": "",
+                                                "value": "1",
                                                 "description": "group Id"
                                             }
                                         ],