Skip to content

Commit a8f4c8f

Browse files
sabrasabra
committed
[java] generateClientAsBean for restclient and webclient
Added possibility to generate restclient and webclient as a @component in the same fashion as resttemplate. Fix #17885 Fix #19229
1 parent 6e9a055 commit a8f4c8f

File tree

7 files changed

+45
-15
lines changed

7 files changed

+45
-15
lines changed

‎docs/generators/java-microprofile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5252
|errorObjectType|Error Object type. (This option is for okhttp-gson only)| |null|
5353
|failOnUnknownProperties|Fail Jackson de-serialization on unknown properties| |false|
5454
|generateBuilders|Whether to generate builders for models| |false|
55-
|generateClientAsBean|For resttemplate, configure whether to create `ApiClient.java` and Apis clients as bean (with `@Component` annotation).| |false|
55+
|generateClientAsBean|For resttemplate, restclient and webclient, configure whether to create `ApiClient.java` and Apis clients as bean (with `@Component` annotation).| |false|
5656
|generateConstructorWithAllArgs|whether to generate a constructor for all arguments| |false|
5757
|gradleProperties|Append additional Gradle properties to the gradle.properties file| |null|
5858
|groupId|groupId in generated pom.xml| |org.openapitools|

‎docs/generators/java.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5252
|errorObjectType|Error Object type. (This option is for okhttp-gson only)| |null|
5353
|failOnUnknownProperties|Fail Jackson de-serialization on unknown properties| |false|
5454
|generateBuilders|Whether to generate builders for models| |false|
55-
|generateClientAsBean|For resttemplate, configure whether to create `ApiClient.java` and Apis clients as bean (with `@Component` annotation).| |false|
55+
|generateClientAsBean|For resttemplate, restclient and webclient, configure whether to create `ApiClient.java` and Apis clients as bean (with `@Component` annotation).| |false|
5656
|generateConstructorWithAllArgs|whether to generate a constructor for all arguments| |false|
5757
|gradleProperties|Append additional Gradle properties to the gradle.properties file| |null|
5858
|groupId|groupId in generated pom.xml| |org.openapitools|

‎modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ public JavaClientCodegen() {
238238
cliOptions.add(CliOption.newString(MICROPROFILE_REST_CLIENT_VERSION, "Version of MicroProfile Rest Client API."));
239239
cliOptions.add(CliOption.newString(CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, "Setting this property to \"true\" will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter. ONLY jersey2, jersey3, okhttp-gson, microprofile, Spring RestClient, Spring WebClient support this option. Setting this property to \"static\" does the same as \"true\", but also makes the generated arguments class static with single parameter instantiation.").defaultValue("false"));
240240
cliOptions.add(CliOption.newBoolean(WEBCLIENT_BLOCKING_OPERATIONS, "Making all WebClient operations blocking(sync). Note that if on operation 'x-webclient-blocking: false' then such operation won't be sync", this.webclientBlockingOperations));
241-
cliOptions.add(CliOption.newBoolean(GENERATE_CLIENT_AS_BEAN, "For resttemplate, configure whether to create `ApiClient.java` and Apis clients as bean (with `@Component` annotation).", this.generateClientAsBean));
241+
cliOptions.add(CliOption.newBoolean(GENERATE_CLIENT_AS_BEAN, "For resttemplate, restclient and webclient, configure whether to create `ApiClient.java` and Apis clients as bean (with `@Component` annotation).", this.generateClientAsBean));
242242
cliOptions.add(CliOption.newBoolean(SUPPORT_URL_QUERY, "Generate toUrlQueryString in POJO (default to true). Available on `native`, `apache-httpclient` libraries."));
243243
cliOptions.add(CliOption.newBoolean(USE_ENUM_CASE_INSENSITIVE, "Use `equalsIgnoreCase` when String for enum comparison", useEnumCaseInsensitive));
244244
cliOptions.add(CliOption.newBoolean(FAIL_ON_UNKNOWN_PROPERTIES, "Fail Jackson de-serialization on unknown properties", this.failOnUnknownProperties));

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ import org.springframework.http.converter.json.MappingJackson2HttpMessageConvert
2323
{{#withXml}}
2424
import org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter;
2525
{{/withXml}}
26+
{{#generateClientAsBean}}
27+
import org.springframework.stereotype.Component;
28+
{{/generateClientAsBean}}
2629
import org.springframework.util.CollectionUtils;
2730
import org.springframework.util.LinkedMultiValueMap;
2831
import org.springframework.util.MultiValueMap;
@@ -61,6 +64,9 @@ import {{invokerPackage}}.auth.OAuth;
6164
{{/hasOAuthMethods}}
6265

6366
{{>generatedAnnotation}}
67+
{{#generateClientAsBean}}
68+
@Component("{{invokerPackage}}.ApiClient")
69+
{{/generateClientAsBean}}
6470
public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
6571
public enum CollectionFormat {
6672
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);
@@ -91,6 +97,9 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
9197
this(null);
9298
}
9399

100+
{{#generateClientAsBean}}
101+
@Autowired
102+
{{/generateClientAsBean}}
94103
public ApiClient(RestClient restClient) {
95104
this(restClient, createDefaultDateFormat());
96105
}

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,25 @@ import {{javaxPackage}}.validation.Valid;
1717

1818
{{/useBeanValidation}}
1919
import org.springframework.beans.factory.annotation.Autowired;
20-
import org.springframework.util.LinkedMultiValueMap;
21-
import org.springframework.util.MultiValueMap;
22-
import org.springframework.core.ParameterizedTypeReference;
23-
import org.springframework.web.client.RestClient.ResponseSpec;
24-
import org.springframework.web.client.RestClientResponseException;
2520
import org.springframework.core.io.FileSystemResource;
21+
import org.springframework.core.ParameterizedTypeReference;
2622
import org.springframework.http.HttpHeaders;
2723
import org.springframework.http.HttpMethod;
2824
import org.springframework.http.HttpStatus;
2925
import org.springframework.http.MediaType;
3026
import org.springframework.http.ResponseEntity;
27+
{{#generateClientAsBean}}
28+
import org.springframework.stereotype.Component;
29+
{{/generateClientAsBean}}
30+
import org.springframework.util.LinkedMultiValueMap;
31+
import org.springframework.util.MultiValueMap;
32+
import org.springframework.web.client.RestClient.ResponseSpec;
33+
import org.springframework.web.client.RestClientResponseException;
3134

3235
{{>generatedAnnotation}}
36+
{{#generateClientAsBean}}
37+
@Component("{{package}}.{{classname}}")
38+
{{/generateClientAsBean}}
3339
{{#operations}}
3440
public class {{classname}} {
3541
private ApiClient apiClient;
@@ -272,4 +278,4 @@ public class {{classname}} {
272278
}
273279
{{/operation}}
274280
}
275-
{{/operations}}
281+
{{/operations}}

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,16 @@ import org.springframework.http.client.BufferingClientHttpRequestFactory;
2222
import org.springframework.http.client.ClientHttpRequestExecution;
2323
import org.springframework.http.client.ClientHttpRequestInterceptor;
2424
import org.springframework.http.client.ClientHttpResponse;
25+
import org.springframework.http.client.reactive.ClientHttpRequest;
2526
import org.springframework.http.codec.json.Jackson2JsonDecoder;
2627
import org.springframework.http.codec.json.Jackson2JsonEncoder;
28+
{{#generateClientAsBean}}
29+
import org.springframework.stereotype.Component;
30+
{{/generateClientAsBean}}
2731
import org.springframework.util.CollectionUtils;
2832
import org.springframework.util.LinkedMultiValueMap;
2933
import org.springframework.util.MultiValueMap;
3034
import org.springframework.util.StringUtils;
31-
import org.springframework.http.client.reactive.ClientHttpRequest;
3235
import org.springframework.web.client.RestClientException;
3336
import org.springframework.web.util.UriComponentsBuilder;
3437
import org.springframework.web.reactive.function.client.WebClient;
@@ -76,6 +79,9 @@ import {{invokerPackage}}.auth.OAuth;
7679
{{/hasOAuthMethods}}
7780

7881
{{>generatedAnnotation}}
82+
{{#generateClientAsBean}}
83+
@Component("{{invokerPackage}}.ApiClient")
84+
{{/generateClientAsBean}}
7985
public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
8086
public enum CollectionFormat {
8187
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);
@@ -111,6 +117,9 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
111117
this.init();
112118
}
113119

120+
{{#generateClientAsBean}}
121+
@Autowired
122+
{{/generateClientAsBean}}
114123
public ApiClient(WebClient webClient) {
115124
this(Optional.ofNullable(webClient).orElseGet(() -> buildWebClient()), createDefaultDateFormat());
116125
}

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

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,27 @@ import {{javaxPackage}}.validation.Valid;
1717

1818
{{/useBeanValidation}}
1919
import org.springframework.beans.factory.annotation.Autowired;
20-
import org.springframework.util.LinkedMultiValueMap;
21-
import org.springframework.util.MultiValueMap;
22-
import org.springframework.core.ParameterizedTypeReference;
23-
import org.springframework.web.reactive.function.client.WebClient.ResponseSpec;
24-
import org.springframework.web.reactive.function.client.WebClientResponseException;
2520
import org.springframework.core.io.FileSystemResource;
21+
import org.springframework.core.ParameterizedTypeReference;
2622
import org.springframework.http.HttpHeaders;
2723
import org.springframework.http.HttpMethod;
2824
import org.springframework.http.HttpStatus;
2925
import org.springframework.http.MediaType;
3026
import org.springframework.http.ResponseEntity;
27+
{{#generateClientAsBean}}
28+
import org.springframework.stereotype.Component;
29+
{{/generateClientAsBean}}
30+
import org.springframework.util.LinkedMultiValueMap;
31+
import org.springframework.util.MultiValueMap;
32+
import org.springframework.web.reactive.function.client.WebClient.ResponseSpec;
33+
import org.springframework.web.reactive.function.client.WebClientResponseException;
3134
import reactor.core.publisher.Mono;
3235
import reactor.core.publisher.Flux;
3336

3437
{{>generatedAnnotation}}
38+
{{#generateClientAsBean}}
39+
@Component("{{package}}.{{classname}}")
40+
{{/generateClientAsBean}}
3541
{{#operations}}
3642
public class {{classname}} {
3743
private ApiClient apiClient;

0 commit comments

Comments
 (0)