[Java][RestTemplate] Fix query parameter URL encoding (#260)

* add URL encoding to the query parameters in case they have unsafe characters * add comment * update generated samples
OpenAPITools · Jun 10, 2018 · 43b60e6 · 43b60e6
1 parent a2c27ba
commit 43b60e6
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/resttemplate/ApiClient.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/resttemplate/ApiClient.mustache
@@ -46,6 +46,7 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
 import java.text.DateFormat;
 import java.text.ParseException;
@@ -527,6 +528,18 @@ public class ApiClient {
         
         final UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(basePath).path(path);
         if (queryParams != null) {
+            //encode the query parameters in case they contain unsafe characters
+            for (List<String> values : queryParams.values()) {
+                if (values != null) {
+                    for (int i = 0; i < values.size(); i++) {
+                        try {
+                            values.set(i, URLEncoder.encode(values.get(i), "utf8"));
+                        } catch (UnsupportedEncodingException e) {
+
+                        }
+                    }
+                }
+            }
             builder.queryParams(queryParams);
         }
 

diff --git a/...t/petstore/java/resttemplate-withXml/src/main/java/org/openapitools/client/ApiClient.java b/...t/petstore/java/resttemplate-withXml/src/main/java/org/openapitools/client/ApiClient.java
@@ -40,6 +40,7 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
 import java.text.DateFormat;
 import java.text.ParseException;
@@ -520,6 +521,18 @@ public <T> T invokeAPI(String path, HttpMethod method, MultiValueMap<String, Str
 
         final UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(basePath).path(path);
         if (queryParams != null) {
+            //encode the query parameters in case they contain unsafe characters
+            for (List<String> values : queryParams.values()) {
+                if (values != null) {
+                    for (int i = 0; i < values.size(); i++) {
+                        try {
+                            values.set(i, URLEncoder.encode(values.get(i), "utf8"));
+                        } catch (UnsupportedEncodingException e) {
+
+                        }
+                    }
+                }
+            }
             builder.queryParams(queryParams);
         }
 

diff --git a/...es/client/petstore/java/resttemplate/src/main/java/org/openapitools/client/ApiClient.java b/...es/client/petstore/java/resttemplate/src/main/java/org/openapitools/client/ApiClient.java
@@ -35,6 +35,7 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
 import java.text.DateFormat;
 import java.text.ParseException;
@@ -515,6 +516,18 @@ public <T> T invokeAPI(String path, HttpMethod method, MultiValueMap<String, Str
 
         final UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(basePath).path(path);
         if (queryParams != null) {
+            //encode the query parameters in case they contain unsafe characters
+            for (List<String> values : queryParams.values()) {
+                if (values != null) {
+                    for (int i = 0; i < values.size(); i++) {
+                        try {
+                            values.set(i, URLEncoder.encode(values.get(i), "utf8"));
+                        } catch (UnsupportedEncodingException e) {
+
+                        }
+                    }
+                }
+            }
             builder.queryParams(queryParams);
         }