Skip to content

Commit bfe4c11

Browse files
wing328wing328
authored
[java][restclient][webclient] add localVar prefix to queryParams variables (#23915)
* add localVar prefix to queryParams variables in rest client * update * update webclient template * update tests
1 parent e241101 commit bfe4c11

81 files changed

Lines changed: 1061 additions & 1061 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎modules/openapi-generator/src/main/resources/Java/libraries/restclient/api.mustache‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,31 +102,31 @@ public class {{classname}} {
102102
{{/pathParams}}
103103
{{/hasPathParams}}
104104

105-
final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
105+
final MultiValueMap<String, String> localVarQueryParams = new LinkedMultiValueMap<>();
106106
final HttpHeaders headerParams = new HttpHeaders();
107107
final MultiValueMap<String, String> cookieParams = new LinkedMultiValueMap<>();
108108
final MultiValueMap<String, Object> formParams = new LinkedMultiValueMap<>();
109109
{{#hasQueryParams}}
110110

111111
{{#queryParams}}
112112
{{#queryIsJsonMimeType}}
113-
queryParams.putAll(apiClient.parameterToMultiValueMapJson({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
113+
localVarQueryParams.putAll(apiClient.parameterToMultiValueMapJson({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
114114
{{/queryIsJsonMimeType}}
115115
{{^queryIsJsonMimeType}}
116116
{{#isExplode}}
117117
{{#hasVars}}
118118
if ({{paramName}} != null) {
119119
{{#vars}}
120-
queryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}.{{getter}}()));
120+
localVarQueryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}.{{getter}}()));
121121
{{/vars}}
122122
}
123123
{{/hasVars}}
124124
{{^hasVars}}
125-
queryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
125+
localVarQueryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
126126
{{/hasVars}}
127127
{{/isExplode}}
128128
{{^isExplode}}
129-
queryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
129+
localVarQueryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
130130
{{/isExplode}}
131131
{{/queryIsJsonMimeType}}
132132
{{/queryParams}}
@@ -165,7 +165,7 @@ public class {{classname}} {
165165
String[] localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{^-last}}, {{/-last}}{{/authMethods}} };
166166

167167
{{#returnType}}ParameterizedTypeReference<{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}> localVarReturnType = new ParameterizedTypeReference<>() {};{{/returnType}}{{^returnType}}ParameterizedTypeReference<Void> localVarReturnType = new ParameterizedTypeReference<>() {};{{/returnType}}
168-
return apiClient.invokeAPI("{{{path}}}", HttpMethod.{{httpMethod}}, pathParams, queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
168+
return apiClient.invokeAPI("{{{path}}}", HttpMethod.{{httpMethod}}, pathParams, localVarQueryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
169169
}
170170

171171
/**

‎modules/openapi-generator/src/main/resources/Java/libraries/webclient/api.mustache‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,29 +104,29 @@ public class {{classname}} {
104104
{{/pathParams}}
105105
{{/hasPathParams}}
106106

107-
final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<String, String>();
107+
final MultiValueMap<String, String> localVarQueryParams = new LinkedMultiValueMap<String, String>();
108108
final HttpHeaders headerParams = new HttpHeaders();
109109
final MultiValueMap<String, String> cookieParams = new LinkedMultiValueMap<String, String>();
110110
final MultiValueMap<String, Object> formParams = new LinkedMultiValueMap<String, Object>();
111111
{{#hasQueryParams}}
112112

113113
{{#queryParams}}
114114
{{#queryIsJsonMimeType}}
115-
queryParams.putAll(apiClient.parameterToMultiValueMapJson({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
115+
localVarQueryParams.putAll(apiClient.parameterToMultiValueMapJson({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
116116
{{/queryIsJsonMimeType}}
117117
{{^queryIsJsonMimeType}}
118118
{{#isExplode}}
119119
{{#hasVars}}
120120
{{#vars}}
121-
queryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}.{{getter}}()));
121+
localVarQueryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}.{{getter}}()));
122122
{{/vars}}
123123
{{/hasVars}}
124124
{{^hasVars}}
125-
queryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
125+
localVarQueryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
126126
{{/hasVars}}
127127
{{/isExplode}}
128128
{{^isExplode}}
129-
queryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
129+
localVarQueryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{.}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
130130
{{/isExplode}}
131131
{{/queryIsJsonMimeType}}
132132
{{/queryParams}}
@@ -165,7 +165,7 @@ public class {{classname}} {
165165
String[] localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{^-last}}, {{/-last}}{{/authMethods}} };
166166

167167
{{#returnType}}ParameterizedTypeReference<{{#vendorExtensions.x-webclient-return-except-list-of-string}}{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnBaseType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnBaseType}}}{{/isResponseFile}}{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{^vendorExtensions.x-webclient-return-except-list-of-string}}{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}{{/vendorExtensions.x-webclient-return-except-list-of-string}}> localVarReturnType = new ParameterizedTypeReference<{{#vendorExtensions.x-webclient-return-except-list-of-string}}{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnBaseType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnBaseType}}}{{/isResponseFile}}{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{^vendorExtensions.x-webclient-return-except-list-of-string}}{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}{{/vendorExtensions.x-webclient-return-except-list-of-string}}>() {};{{/returnType}}{{^returnType}}ParameterizedTypeReference<Void> localVarReturnType = new ParameterizedTypeReference<Void>() {};{{/returnType}}
168-
return apiClient.invokeAPI("{{{path}}}", HttpMethod.{{httpMethod}}, pathParams, queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
168+
return apiClient.invokeAPI("{{{path}}}", HttpMethod.{{httpMethod}}, pathParams, localVarQueryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
169169
}
170170

171171
/**

‎modules/openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2105,16 +2105,16 @@ public void shouldProperlyExplodeWebClientQueryParameters() {
21052105
.printFileContent()
21062106
.assertMethod("searchRequestCreation")
21072107
.bodyContainsLines(
2108-
"queryParams.putAll(apiClient.parameterToMultiValueMap(null, \"regular-param\","
2108+
"localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, \"regular-param\","
21092109
+ " regularParam));")
21102110
.bodyContainsLines(
2111-
"queryParams.putAll(apiClient.parameterToMultiValueMap(null, \"someString\","
2111+
"localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, \"someString\","
21122112
+ " objectParam.getSomeString()));")
21132113
.bodyContainsLines(
2114-
"queryParams.putAll(apiClient.parameterToMultiValueMap(null, \"someBoolean\","
2114+
"localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, \"someBoolean\","
21152115
+ " objectParam.getSomeBoolean()));")
21162116
.bodyContainsLines(
2117-
"queryParams.putAll(apiClient.parameterToMultiValueMap(null, \"someInteger\","
2117+
"localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, \"someInteger\","
21182118
+ " objectParam.getSomeInteger()));");
21192119
}
21202120

@@ -4248,11 +4248,11 @@ public void queryParameterJsonSerialization(String library) {
42484248
new DefaultGenerator().opts(configurator.toClientOptInput()).generate();
42494249
assertFileContains(
42504250
output.resolve("src/main/java/org/openapitools/client/api/QueryApi.java"),
4251-
"queryParams.putAll(apiClient.parameterToMultiValueMapJson(null, \"json_serialized_object_ref_string_query\", jsonSerializedObjectRefStringQuery));"
4251+
"localVarQueryParams.putAll(apiClient.parameterToMultiValueMapJson(null, \"json_serialized_object_ref_string_query\", jsonSerializedObjectRefStringQuery));"
42524252
);
42534253
assertFileContains(
42544254
output.resolve("src/main/java/org/openapitools/client/api/QueryApi.java"),
4255-
"queryParams.putAll(apiClient.parameterToMultiValueMapJson(ApiClient.CollectionFormat" +
4255+
"localVarQueryParams.putAll(apiClient.parameterToMultiValueMapJson(ApiClient.CollectionFormat" +
42564256
".valueOf(\"csv\".toUpperCase(Locale.ROOT)), \"json_serialized_object_array_ref_string_query\", jsonSerializedObjectArrayRefStringQuery));"
42574257
);
42584258
}

‎samples/client/echo_api/java/restclient/src/main/java/org/openapitools/client/api/AuthApi.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ private ResponseSpec testAuthHttpBasicRequestCreation() throws RestClientRespons
5555
// create path and map variables
5656
final Map<String, Object> pathParams = new HashMap<>();
5757

58-
final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
58+
final MultiValueMap<String, String> localVarQueryParams = new LinkedMultiValueMap<>();
5959
final HttpHeaders headerParams = new HttpHeaders();
6060
final MultiValueMap<String, String> cookieParams = new LinkedMultiValueMap<>();
6161
final MultiValueMap<String, Object> formParams = new LinkedMultiValueMap<>();
@@ -70,7 +70,7 @@ private ResponseSpec testAuthHttpBasicRequestCreation() throws RestClientRespons
7070
String[] localVarAuthNames = new String[] { "http_auth" };
7171

7272
ParameterizedTypeReference<String> localVarReturnType = new ParameterizedTypeReference<>() {};
73-
return apiClient.invokeAPI("/auth/http/basic", HttpMethod.POST, pathParams, queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
73+
return apiClient.invokeAPI("/auth/http/basic", HttpMethod.POST, pathParams, localVarQueryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
7474
}
7575

7676
/**
@@ -120,7 +120,7 @@ private ResponseSpec testAuthHttpBearerRequestCreation() throws RestClientRespon
120120
// create path and map variables
121121
final Map<String, Object> pathParams = new HashMap<>();
122122

123-
final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
123+
final MultiValueMap<String, String> localVarQueryParams = new LinkedMultiValueMap<>();
124124
final HttpHeaders headerParams = new HttpHeaders();
125125
final MultiValueMap<String, String> cookieParams = new LinkedMultiValueMap<>();
126126
final MultiValueMap<String, Object> formParams = new LinkedMultiValueMap<>();
@@ -135,7 +135,7 @@ private ResponseSpec testAuthHttpBearerRequestCreation() throws RestClientRespon
135135
String[] localVarAuthNames = new String[] { "http_bearer_auth" };
136136

137137
ParameterizedTypeReference<String> localVarReturnType = new ParameterizedTypeReference<>() {};
138-
return apiClient.invokeAPI("/auth/http/bearer", HttpMethod.POST, pathParams, queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
138+
return apiClient.invokeAPI("/auth/http/bearer", HttpMethod.POST, pathParams, localVarQueryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
139139
}
140140

141141
/**

0 commit comments

Comments
 (0)