Merge remote-tracking branch 'origin/master' into 2.3.0

modules/swagger-codegen/src/main/resources/Java/libraries/feign/EncodingUtils.mustache

@@ -0,0 +1,86 @@
+package {{invokerPackage}};
+
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+/**
+* Utilities to support Swagger encoding formats in Feign.
+*/
+public final class EncodingUtils {
+
+  /**
+   * Private constructor. Do not construct this class.
+   */
+  private EncodingUtils() {}
+
+  /**
+   * <p>Encodes a collection of query parameters according to the Swagger
+   * collection format.</p>
+   *
+   * <p>Of the various collection formats defined by Swagger ("csv", "tsv",
+   * etc), Feign only natively supports "multi". This utility generates the
+   * other format types so it will be properly processed by Feign.</p>
+   *
+   * <p>Note, as part of reformatting, it URL encodes the parameters as
+   * well.</p>
+   * @param parameters The collection object to be formatted. This object will
+   *                   not be changed.
+   * @param collectionFormat The Swagger collection format (eg, "csv", "tsv",
+   *                         "pipes"). See the
+   *                         <a href="http://swagger.io/specification/#parameter-object-44">
+   *                         Swagger Spec</a> for more details.
+   * @return An object that will be correctly formatted by Feign.
+   */
+  public static Object encodeCollection(Collection<?> parameters,
+                                     String collectionFormat) {
+    if (parameters == null) {
+      return parameters;
+    }
+    List<String> stringValues = new ArrayList<>(parameters.size());
+    for (Object parameter : parameters) {
+      // ignore null values (same behavior as Feign)
+      if (parameter != null) {
+        stringValues.add(encode(parameter));
+      }
+    }
+    // Feign natively handles single-element lists and the "multi" format.
+    if (stringValues.size() < 2 || "multi".equals(collectionFormat)) {
+      return stringValues;
+    }
+    // Otherwise return a formatted String
+    String[] stringArray = stringValues.toArray(new String[0]);
+    switch (collectionFormat) {
+      case "csv":
+      default:
+        return StringUtil.join(stringArray, ",");
+      case "ssv":
+        return StringUtil.join(stringArray, " ");
+      case "tsv":
+        return StringUtil.join(stringArray, "\t");
+      case "pipes":
+        return StringUtil.join(stringArray, "|");
+    }
+  }
+
+  /**
+   * URL encode a single query parameter.
+   * @param parameter The query parameter to encode. This object will not be
+   *                  changed.
+   * @return The URL encoded string representation of the parameter. If the
+   *         parameter is null, returns null.
+   */
+  public static String encode(Object parameter) {
+    if (parameter == null) {
+      return null;
+    }
+    try {
+      return URLEncoder.encode(parameter.toString(), "UTF-8");
+    } catch (UnsupportedEncodingException e) {
+      // Should never happen, UTF-8 is always supported
+      throw new RuntimeException(e);
+    }
+  }
+}

modules/swagger-codegen/src/main/resources/Java/libraries/feign/api.mustache

@@ -1,6 +1,7 @@
 package {{package}};
 
 import {{invokerPackage}}.ApiClient;
+import {{invokerPackage}}.EncodingUtils;
 {{#legacyDates}}
 import {{invokerPackage}}.ParamExpander;
 {{/legacyDates}}
@@ -71,7 +72,7 @@ public interface {{classname}} extends ApiClient.Api {
       "{{baseName}}: {{=<% %>=}}{<%paramName%>}<%={{ }}=%>"{{#hasMore}},
       {{/hasMore}}{{/headerParams}}
   })
-  {{#returnType}}{{{returnType}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{nickname}}({{#allParams}}{{^isQueryParam}}{{^isBodyParam}}{{^legacyDates}}@Param("{{paramName}}") {{/legacyDates}}{{#legacyDates}}@Param(value="{{paramName}}", expander=ParamExpander.class) {{/legacyDates}}{{/isBodyParam}}{{{dataType}}} {{paramName}}, {{/isQueryParam}}{{/allParams}}@QueryMap Map<String, Object> queryParams);
+  {{#returnType}}{{{returnType}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{nickname}}({{#allParams}}{{^isQueryParam}}{{^isBodyParam}}{{^legacyDates}}@Param("{{paramName}}") {{/legacyDates}}{{#legacyDates}}@Param(value="{{paramName}}", expander=ParamExpander.class) {{/legacyDates}}{{/isBodyParam}}{{{dataType}}} {{paramName}}, {{/isQueryParam}}{{/allParams}}@QueryMap(encoded=true) Map<String, Object> queryParams);
 
   /**
    * A convenience class for generating query parameters for the
@@ -80,7 +81,12 @@ public interface {{classname}} extends ApiClient.Api {
   public static class {{operationIdCamelCase}}QueryParams extends HashMap<String, Object> {
       {{#queryParams}}
     public {{operationIdCamelCase}}QueryParams {{paramName}}(final {{{dataType}}} value) {
-      put("{{baseName}}", value);
+        {{#collectionFormat}}
+      put("{{baseName}}", EncodingUtils.encodeCollection(value, "{{collectionFormat}}"));
+        {{/collectionFormat}}
+        {{^collectionFormat}}
+      put("{{baseName}}", EncodingUtils.encode(value));
+        {{/collectionFormat}}
       return this;
     }
       {{/queryParams}}

modules/swagger-codegen/src/main/resources/Java/libraries/feign/pom.mustache

@@ -246,6 +246,18 @@
       <version>${junit-version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.squareup.okhttp3</groupId>
+      <artifactId>mockwebserver</artifactId>
+      <version>3.6.0</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <version>1.7.1</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
   <properties>
     <java.version>{{#java8}}1.8{{/java8}}{{^java8}}1.7{{/java8}}</java.version>