Merge pull request #790 from xhh/java-accept-contenttype

Minor improvement to Java API client accept and content-type header

Author: fehguy

modules/swagger-codegen/src/main/java/com/wordnik/swagger/codegen/languages/JavaClientCodegen.java

@@ -109,9 +109,10 @@ public void processOpts() {
     final String invokerFolder = (sourceFolder + File.separator + invokerPackage).replace(".", File.separator);
     supportingFiles.add(new SupportingFile("pom.mustache", "", "pom.xml"));
     supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
-    supportingFiles.add(new SupportingFile("JsonUtil.mustache", invokerFolder, "JsonUtil.java"));
     supportingFiles.add(new SupportingFile("apiException.mustache", invokerFolder, "ApiException.java"));
     supportingFiles.add(new SupportingFile("Configuration.mustache", invokerFolder, "Configuration.java"));
+    supportingFiles.add(new SupportingFile("JsonUtil.mustache", invokerFolder, "JsonUtil.java"));
+    supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
 
     final String authFolder = (sourceFolder + File.separator + invokerPackage + ".auth").replace(".", File.separator);
     supportingFiles.add(new SupportingFile("auth/Authentication.mustache", authFolder, "Authentication.java"));

modules/swagger-codegen/src/main/resources/Java/ApiClient.mustache

@@ -238,6 +238,36 @@ public class ApiClient {
     }
   }
 
+  /**
+   * Select the Accept header's value from the given accepts array:
+   *   if JSON exists in the given array, use it;
+   *   otherwise use all of them (joining into a string)
+   *
+   * @param accepts The accepts array to select from
+   * @return The Accept header to use. If the given array is empty,
+   *   null will be returned (not to set the Accept header explicitly).
+   */
+  public String selectHeaderAccept(String[] accepts) {
+    if (accepts.length == 0) return null;
+    if (StringUtil.containsIgnoreCase(accepts, "application/json")) return "application/json";
+    return StringUtil.join(accepts, ",");
+  }
+
+  /**
+   * Select the Content-Type header's value from the given array:
+   *   if JSON exists in the given array, use it;
+   *   otherwise use the first one of the array.
+   *
+   * @param contentTypes The Content-Type array to select from
+   * @return The Content-Type header to use. If the given array is empty,
+   *   JSON will be used.
+   */
+  public String selectHeaderContentType(String[] contentTypes) {
+    if (contentTypes.length == 0) return "application/json";
+    if (StringUtil.containsIgnoreCase(contentTypes, "application/json")) return "application/json";
+    return contentTypes[0];
+  }
+
   /**
    * Escape the given string to be used as URL query value.
    */
@@ -306,11 +336,12 @@ public class ApiClient {
    * @param body The request body object
    * @param headerParams The header parameters
    * @param formParams The form parameters
-   * @param contentType The request Content-Type
+   * @param accept The request's Accept header
+   * @param contentType The request's Content-Type header
    * @param authNames The authentications to apply
    * @return The response body in type of string
    */
-  public String invokeAPI(String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String contentType, String[] authNames) throws ApiException {
+  public String invokeAPI(String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String accept, String contentType, String[] authNames) throws ApiException {
     updateParamsForAuth(authNames, queryParams, headerParams);
 
     Client client = getClient();
@@ -328,16 +359,21 @@ public class ApiClient {
     }
     String querystring = b.toString();
 
-    Builder builder = client.resource(basePath + path + querystring).accept("application/json");
+    Builder builder;
+    if (accept == null)
+      builder = client.resource(basePath + path + querystring).getRequestBuilder();
+    else
+      builder = client.resource(basePath + path + querystring).accept(accept);
+
     for(String key : headerParams.keySet()) {
       builder = builder.header(key, headerParams.get(key));
     }
-
     for(String key : defaultHeaderMap.keySet()) {
       if(!headerParams.containsKey(key)) {
         builder = builder.header(key, defaultHeaderMap.get(key));
       }
     }
+
     ClientResponse response = null;
 
     if("GET".equals(method)) {

modules/swagger-codegen/src/main/resources/Java/StringUtil.mustache

@@ -0,0 +1,41 @@
+package {{invokerPackage}};
+
+public class StringUtil {
+  /**
+   * Check if the given array contains the given value (with case-insensitive comparison).
+   *
+   * @param array The array
+   * @param value The value to search
+   * @return true if the array contains the value
+   */
+  public static boolean containsIgnoreCase(String[] array, String value) {
+    for (String str : array) {
+      if (value == null && str == null) return true;
+      if (value != null && value.equalsIgnoreCase(str)) return true;
+    }
+    return false;
+  }
+
+  /**
+   * Join an array of strings with the given separator.
+   * <p>
+   * Note: This might be replaced by utility method from commons-lang or guava someday
+   * if one of those libraries is added as dependency.
+   * </p>
+   *
+   * @param array     The array of strings
+   * @param separator The separator
+   * @return the resulting string
+   */
+  public static String join(String[] array, String separator) {
+    int len = array.length;
+    if (len == 0) return "";
+
+    StringBuilder out = new StringBuilder();
+    out.append(array[0]);
+    for (int i = 1; i < len; i++) {
+      out.append(separator).append(array[i]);
+    }
+    return out.toString();
+  }
+}

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

@@ -68,14 +68,20 @@ public class {{classname}} {
     {{#queryParams}}if ({{paramName}} != null)
       queryParams.put("{{baseName}}", apiClient.parameterToString({{paramName}}));
     {{/queryParams}}
+
     {{#headerParams}}if ({{paramName}} != null)
       headerParams.put("{{baseName}}", apiClient.parameterToString({{paramName}}));
     {{/headerParams}}
-    String[] contentTypes = {
-      {{#consumes}}"{{mediaType}}"{{#hasMore}},{{/hasMore}}{{/consumes}}
+
+    final String[] accepts = {
+      {{#produces}}"{{mediaType}}"{{#hasMore}}, {{/hasMore}}{{/produces}}
     };
+    final String accept = apiClient.selectHeaderAccept(accepts);
 
-    String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json";
+    final String[] contentTypes = {
+      {{#consumes}}"{{mediaType}}"{{#hasMore}}, {{/hasMore}}{{/consumes}}
+    };
+    final String contentType = apiClient.selectHeaderContentType(contentTypes);
 
     if(contentType.startsWith("multipart/form-data")) {
       boolean hasFields = false;
@@ -103,7 +109,7 @@ public class {{classname}} {
 
     try {
       String[] authNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
-      String response = apiClient.invokeAPI(path, "{{httpMethod}}", queryParams, postBody, headerParams, formParams, contentType, authNames);
+      String response = apiClient.invokeAPI(path, "{{httpMethod}}", queryParams, postBody, headerParams, formParams, accept, contentType, authNames);
       if(response != null){
         return {{#returnType}}({{{returnType}}}) apiClient.deserialize(response, "{{returnContainer}}", {{returnBaseType}}.class){{/returnType}};
       }

samples/client/petstore/java/src/main/java/io/swagger/client/ApiClient.java

@@ -237,6 +237,36 @@ public String parameterToString(Object param) {
     }
   }
 
+  /**
+   * Select the Accept header's value from the given accepts array:
+   *   if JSON exists in the given array, use it;
+   *   otherwise use all of them (joining into a string)
+   *
+   * @param accepts The accepts array to select from
+   * @return The Accept header to use. If the given array is empty,
+   *   null will be returned (not to set the Accept header explicitly).
+   */
+  public String selectHeaderAccept(String[] accepts) {
+    if (accepts.length == 0) return null;
+    if (StringUtil.containsIgnoreCase(accepts, "application/json")) return "application/json";
+    return StringUtil.join(accepts, ",");
+  }
+
+  /**
+   * Select the Content-Type header's value from the given array:
+   *   if JSON exists in the given array, use it;
+   *   otherwise use the first one of the array.
+   *
+   * @param contentTypes The Content-Type array to select from
+   * @return The Content-Type header to use. If the given array is empty,
+   *   JSON will be used.
+   */
+  public String selectHeaderContentType(String[] contentTypes) {
+    if (contentTypes.length == 0) return "application/json";
+    if (StringUtil.containsIgnoreCase(contentTypes, "application/json")) return "application/json";
+    return contentTypes[0];
+  }
+
   /**
    * Escape the given string to be used as URL query value.
    */
@@ -305,11 +335,12 @@ public String serialize(Object obj) throws ApiException {
    * @param body The request body object
    * @param headerParams The header parameters
    * @param formParams The form parameters
-   * @param contentType The request Content-Type
+   * @param accept The request's Accept header
+   * @param contentType The request's Content-Type header
    * @param authNames The authentications to apply
    * @return The response body in type of string
    */
-  public String invokeAPI(String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String contentType, String[] authNames) throws ApiException {
+  public String invokeAPI(String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String accept, String contentType, String[] authNames) throws ApiException {
     updateParamsForAuth(authNames, queryParams, headerParams);
 
     Client client = getClient();
@@ -327,16 +358,21 @@ public String invokeAPI(String path, String method, Map<String, String> queryPar
     }
     String querystring = b.toString();
 
-    Builder builder = client.resource(basePath + path + querystring).accept("application/json");
+    Builder builder;
+    if (accept == null)
+      builder = client.resource(basePath + path + querystring).getRequestBuilder();
+    else
+      builder = client.resource(basePath + path + querystring).accept(accept);
+
     for(String key : headerParams.keySet()) {
       builder = builder.header(key, headerParams.get(key));
     }
-
     for(String key : defaultHeaderMap.keySet()) {
       if(!headerParams.containsKey(key)) {
         builder = builder.header(key, defaultHeaderMap.get(key));
       }
     }
+
     ClientResponse response = null;
 
     if("GET".equals(method)) {

samples/client/petstore/java/src/main/java/io/swagger/client/StringUtil.java

@@ -0,0 +1,41 @@
+package io.swagger.client;
+
+public class StringUtil {
+  /**
+   * Check if the given array contains the given value (with case-insensitive comparison).
+   *
+   * @param array The array
+   * @param value The value to search
+   * @return true if the array contains the value
+   */
+  public static boolean containsIgnoreCase(String[] array, String value) {
+    for (String str : array) {
+      if (value == null && str == null) return true;
+      if (value != null && value.equalsIgnoreCase(str)) return true;
+    }
+    return false;
+  }
+
+  /**
+   * Join an array of strings with the given separator.
+   * <p>
+   * Note: This might be replaced by utility method from commons-lang or guava someday
+   * if one of those libraries is added as dependency.
+   * </p>
+   *
+   * @param array     The array of strings
+   * @param separator The separator
+   * @return the resulting string
+   */
+  public static String join(String[] array, String separator) {
+    int len = array.length;
+    if (len == 0) return "";
+
+    StringBuilder out = new StringBuilder();
+    out.append(array[0]);
+    for (int i = 1; i < len; i++) {
+      out.append(separator).append(array[i]);
+    }
+    return out.toString();
+  }
+}