Skip to content

Commit 5f547b8

Browse files
wing328wing328
authored
[Java][WebClient] better code format (#5433)
* better code format for java webclient * prefix local varaible with localVar
1 parent ba0d673 commit 5f547b8

File tree

9 files changed

+318
-408
lines changed

9 files changed

+318
-408
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ public class ApiClient {
555555
updateParamsForAuth(authNames, queryParams, headerParams, cookieParams);
556556
557557
final UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(basePath).path(path);
558-
if (queryParams != null) {
558+
if (queryParams != null) {
559559
builder.queryParams(queryParams);
560560
}
561561

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

Lines changed: 47 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ import {{invokerPackage}}.ApiClient;
44

55
{{#imports}}import {{import}};
66
{{/imports}}
7+
{{^fullJavaUtil}}
78

8-
{{^fullJavaUtil}}import java.util.HashMap;
9+
import java.util.HashMap;
910
import java.util.List;
1011
import java.util.Locale;
11-
import java.util.Map;{{/fullJavaUtil}}
12+
import java.util.Map;
13+
{{/fullJavaUtil}}
1214

1315
import org.springframework.beans.factory.annotation.Autowired;
1416
import org.springframework.util.LinkedMultiValueMap;
@@ -62,49 +64,68 @@ public class {{classname}} {
6264
*/
6365
public {{#returnType}}{{#isListContainer}}Flux<{{{returnBaseType}}}>{{/isListContainer}}{{^isListContainer}}Mono<{{{returnType}}}>{{/isListContainer}} {{/returnType}}{{^returnType}}Mono<Void> {{/returnType}}{{operationId}}({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws RestClientException {
6466
Object postBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};
65-
{{#allParams}}{{#required}}
67+
{{#allParams}}
68+
{{#required}}
6669
// verify the required parameter '{{paramName}}' is set
6770
if ({{paramName}} == null) {
6871
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter '{{paramName}}' when calling {{operationId}}");
6972
}
70-
{{/required}}{{/allParams}}
73+
{{/required}}
74+
{{/allParams}}
7175
// create path and map variables
72-
final Map<String, Object> pathParams = new HashMap<String, Object>();{{#hasPathParams}}{{#pathParams}}
73-
pathParams.put("{{baseName}}", {{#collectionFormat}}apiClient.collectionPathParameterToString(ApiClient.CollectionFormat.valueOf("csv".toUpperCase()), {{/collectionFormat}}{{{paramName}}}{{#collectionFormat}}){{/collectionFormat}});{{/pathParams}}{{/hasPathParams}}
76+
final Map<String, Object> pathParams = new HashMap<String, Object>();
77+
{{#hasPathParams}}
7478

79+
{{#pathParams}}
80+
pathParams.put("{{baseName}}", {{#collectionFormat}}apiClient.collectionPathParameterToString(ApiClient.CollectionFormat.valueOf("csv".toUpperCase()), {{/collectionFormat}}{{{paramName}}}{{#collectionFormat}}){{/collectionFormat}});
81+
{{/pathParams}}
82+
{{/hasPathParams}}
7583

7684
final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<String, String>();
7785
final HttpHeaders headerParams = new HttpHeaders();
7886
final MultiValueMap<String, String> cookieParams = new LinkedMultiValueMap<String, String>();
79-
final MultiValueMap<String, Object> formParams = new LinkedMultiValueMap<String, Object>();{{#hasQueryParams}}
87+
final MultiValueMap<String, Object> formParams = new LinkedMultiValueMap<String, Object>();
88+
{{#hasQueryParams}}
8089

81-
{{#queryParams}}queryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{collectionFormat}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));{{#hasMore}}
82-
{{/hasMore}}{{/queryParams}}{{/hasQueryParams}}{{#hasHeaderParams}}
90+
{{#queryParams}}
91+
queryParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{collectionFormat}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
92+
{{/queryParams}}
93+
{{/hasQueryParams}}
94+
{{#hasHeaderParams}}
8395

84-
{{#headerParams}}if ({{paramName}} != null)
96+
{{#headerParams}}
97+
if ({{paramName}} != null)
8598
headerParams.add("{{baseName}}", apiClient.parameterToString({{paramName}}));{{#hasMore}}
86-
{{/hasMore}}{{/headerParams}}{{/hasHeaderParams}}{{#hasCookieParams}}
87-
88-
{{#cookieParams}}cookieParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{collectionFormat}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));{{#hasMore}}
89-
{{/hasMore}}{{/cookieParams}}{{/hasCookieParams}}{{#hasFormParams}}
90-
91-
{{#formParams}}if ({{paramName}} != null)
92-
formParams.add{{#collectionFormat}}All{{/collectionFormat}}("{{baseName}}", {{#isFile}}new FileSystemResource({{paramName}}){{/isFile}}{{^isFile}}{{paramName}}{{/isFile}});{{#hasMore}}
93-
{{/hasMore}}{{/formParams}}{{/hasFormParams}}
94-
95-
final String[] accepts = { {{#hasProduces}}
99+
{{/hasMore}}
100+
{{/headerParams}}
101+
{{/hasHeaderParams}}
102+
{{#hasCookieParams}}
103+
104+
{{#cookieParams}}
105+
cookieParams.putAll(apiClient.parameterToMultiValueMap({{#collectionFormat}}ApiClient.CollectionFormat.valueOf("{{{collectionFormat}}}".toUpperCase(Locale.ROOT)){{/collectionFormat}}{{^collectionFormat}}null{{/collectionFormat}}, "{{baseName}}", {{paramName}}));
106+
{{/cookieParams}}
107+
{{/hasCookieParams}}
108+
{{#hasFormParams}}
109+
110+
{{#formParams}}
111+
if ({{paramName}} != null)
112+
formParams.add{{#collectionFormat}}All{{/collectionFormat}}("{{baseName}}", {{#isFile}}new FileSystemResource({{paramName}}){{/isFile}}{{^isFile}}{{paramName}}{{/isFile}});
113+
{{/formParams}}
114+
{{/hasFormParams}}
115+
116+
final String[] localVarAccepts = { {{#hasProduces}}
96117
{{#produces}}"{{{mediaType}}}"{{#hasMore}}, {{/hasMore}}{{/produces}}
97118
{{/hasProduces}}};
98-
final List<MediaType> accept = apiClient.selectHeaderAccept(accepts);
99-
final String[] contentTypes = { {{#hasConsumes}}
119+
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
120+
final String[] localVarContentTypes = { {{#hasConsumes}}
100121
{{#consumes}}"{{{mediaType}}}"{{#hasMore}}, {{/hasMore}}{{/consumes}}
101122
{{/hasConsumes}}};
102-
final MediaType contentType = apiClient.selectHeaderContentType(contentTypes);
123+
final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
103124

104-
String[] authNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
125+
String[] localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
105126

106-
{{#returnType}}ParameterizedTypeReference<{{#isListContainer}}{{{returnBaseType}}}{{/isListContainer}}{{^isListContainer}}{{{returnType}}}{{/isListContainer}}> returnType = new ParameterizedTypeReference<{{#isListContainer}}{{{returnBaseType}}}{{/isListContainer}}{{^isListContainer}}{{{returnType}}}{{/isListContainer}}>() {};{{/returnType}}{{^returnType}}ParameterizedTypeReference<Void> returnType = new ParameterizedTypeReference<Void>() {};{{/returnType}}
107-
return apiClient.{{#isListContainer}}invokeFluxAPI{{/isListContainer}}{{^isListContainer}}invokeAPI{{/isListContainer}}("{{{path}}}", HttpMethod.{{httpMethod}}, pathParams, queryParams, postBody, headerParams, cookieParams, formParams, accept, contentType, authNames, returnType);
127+
{{#returnType}}ParameterizedTypeReference<{{#isListContainer}}{{{returnBaseType}}}{{/isListContainer}}{{^isListContainer}}{{{returnType}}}{{/isListContainer}}> localVarReturnType = new ParameterizedTypeReference<{{#isListContainer}}{{{returnBaseType}}}{{/isListContainer}}{{^isListContainer}}{{{returnType}}}{{/isListContainer}}>() {};{{/returnType}}{{^returnType}}ParameterizedTypeReference<Void> localVarReturnType = new ParameterizedTypeReference<Void>() {};{{/returnType}}
128+
return apiClient.{{#isListContainer}}invokeFluxAPI{{/isListContainer}}{{^isListContainer}}invokeAPI{{/isListContainer}}("{{{path}}}", HttpMethod.{{httpMethod}}, pathParams, queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
108129
}
109130
{{/operation}}
110131
}

‎samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/ApiClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,7 @@ private WebClient.RequestBodySpec prepareRequest(String path, HttpMethod method,
551551
updateParamsForAuth(authNames, queryParams, headerParams, cookieParams);
552552

553553
final UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(basePath).path(path);
554-
if (queryParams != null) {
554+
if (queryParams != null) {
555555
builder.queryParams(queryParams);
556556
}
557557

‎samples/client/petstore/java/webclient/src/main/java/org/openapitools/client/api/AnotherFakeApi.java

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,33 +55,30 @@ public void setApiClient(ApiClient apiClient) {
5555
*/
5656
public Mono<Client> call123testSpecialTags(Client body) throws RestClientException {
5757
Object postBody = body;
58-
5958
// verify the required parameter 'body' is set
6059
if (body == null) {
6160
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling call123testSpecialTags");
6261
}
63-
6462
// create path and map variables
6563
final Map<String, Object> pathParams = new HashMap<String, Object>();
6664

67-
6865
final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<String, String>();
6966
final HttpHeaders headerParams = new HttpHeaders();
7067
final MultiValueMap<String, String> cookieParams = new LinkedMultiValueMap<String, String>();
7168
final MultiValueMap<String, Object> formParams = new LinkedMultiValueMap<String, Object>();
7269

73-
final String[] accepts = {
70+
final String[] localVarAccepts = {
7471
"application/json"
7572
};
76-
final List<MediaType> accept = apiClient.selectHeaderAccept(accepts);
77-
final String[] contentTypes = {
73+
final List<MediaType> localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
74+
final String[] localVarContentTypes = {
7875
"application/json"
7976
};
80-
final MediaType contentType = apiClient.selectHeaderContentType(contentTypes);
77+
final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
8178

82-
String[] authNames = new String[] { };
79+
String[] localVarAuthNames = new String[] { };
8380

84-
ParameterizedTypeReference<Client> returnType = new ParameterizedTypeReference<Client>() {};
85-
return apiClient.invokeAPI("/another-fake/dummy", HttpMethod.PATCH, pathParams, queryParams, postBody, headerParams, cookieParams, formParams, accept, contentType, authNames, returnType);
81+
ParameterizedTypeReference<Client> localVarReturnType = new ParameterizedTypeReference<Client>() {};
82+
return apiClient.invokeAPI("/another-fake/dummy", HttpMethod.PATCH, pathParams, queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
8683
}
8784
}

0 commit comments

Comments
 (0)