Skip to content

Commit a6280d9

Browse files
cchacinmartin-mfg
cchacin
and
martin-mfg
authored
[java][client] fix: Add static modifier to inner class in Java when useSingleRequestParameter=true (#20590)
* fix: Add static modifier to inner class * Apply suggestions from code review Co-authored-by: martin-mfg <2026226+martin-mfg@users.noreply.github.com> * fix: Remove unintended whitespace * fix: Add default=false for useSingleRequestParameter --------- Co-authored-by: martin-mfg <2026226+martin-mfg@users.noreply.github.com>
1 parent 4ba87ae commit a6280d9

7 files changed

Lines changed: 58 additions & 19 deletions

File tree

‎docs/generators/java-microprofile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
100100
|useRuntimeException|Use RuntimeException instead of Exception. Only jersey2, jersey3, okhttp-gson, vertx, microprofile support this option.| |false|
101101
|useRxJava2|Whether to use the RxJava2 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated.| |false|
102102
|useRxJava3|Whether to use the RxJava3 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated.| |false|
103-
|useSingleRequestParameter|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.| |false|
103+
|useSingleRequestParameter|Setting this property to &quot;true&quot; 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 &quot;static&quot; does the same as &quot;true&quot;, but also makes the generated arguments class static. Only WebClient supports this option.| |false|
104104
|webclientBlockingOperations|Making all WebClient operations blocking(sync). Note that if on operation 'x-webclient-blocking: false' then such operation won't be sync| |false|
105105
|withAWSV4Signature|whether to include AWS v4 signature support (only available for okhttp-gson library)| |false|
106106
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|

‎docs/generators/java.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
100100
|useRuntimeException|Use RuntimeException instead of Exception. Only jersey2, jersey3, okhttp-gson, vertx, microprofile support this option.| |false|
101101
|useRxJava2|Whether to use the RxJava2 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated.| |false|
102102
|useRxJava3|Whether to use the RxJava3 adapter with the retrofit2 library. IMPORTANT: This option has been deprecated.| |false|
103-
|useSingleRequestParameter|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.| |false|
103+
|useSingleRequestParameter|Setting this property to &quot;true&quot; 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 &quot;static&quot; does the same as &quot;true&quot;, but also makes the generated arguments class static. Only WebClient supports this option.| |false|
104104
|webclientBlockingOperations|Making all WebClient operations blocking(sync). Note that if on operation 'x-webclient-blocking: false' then such operation won't be sync| |false|
105105
|withAWSV4Signature|whether to include AWS v4 signature support (only available for okhttp-gson library)| |false|
106106
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|

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

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ public class JavaClientCodegen extends AbstractJavaCodegen
144144
@Setter protected boolean useOneOfDiscriminatorLookup = false; // use oneOf discriminator's mapping for model lookup
145145
protected String rootJavaEEPackage;
146146
protected Map<String, MpRestClientVersion> mpRestClientVersions = new LinkedHashMap<>();
147-
@Setter(AccessLevel.PRIVATE) protected boolean useSingleRequestParameter = false;
147+
@Setter(AccessLevel.PRIVATE) protected String useSingleRequestParameter = "false";
148148
protected boolean webclientBlockingOperations = false;
149149
@Setter protected boolean generateClientAsBean = false;
150150
@Setter protected boolean useEnumCaseInsensitive = false;
@@ -237,7 +237,7 @@ public JavaClientCodegen() {
237237
cliOptions.add(CliOption.newString(CONFIG_KEY_FROM_CLASS_NAME, "If true, set tag as key in @RegisterRestClient. Default to false. Only `microprofile` supports this option."));
238238
cliOptions.add(CliOption.newBoolean(CodegenConstants.USE_ONEOF_DISCRIMINATOR_LOOKUP, CodegenConstants.USE_ONEOF_DISCRIMINATOR_LOOKUP_DESC + " Only jersey2, jersey3, native, okhttp-gson support this option."));
239239
cliOptions.add(CliOption.newString(MICROPROFILE_REST_CLIENT_VERSION, "Version of MicroProfile Rest Client API."));
240-
cliOptions.add(CliOption.newBoolean(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."));
240+
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. Only WebClient supports this option.").defaultValue("false"));
241241
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));
242242
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));
243243
cliOptions.add(CliOption.newBoolean(SUPPORT_URL_QUERY, "Generate toUrlQueryString in POJO (default to true). Available on `native`, `apache-httpclient` libraries."));
@@ -334,7 +334,9 @@ public void processOpts() {
334334
convertPropertyToBooleanAndWriteBack(USE_RX_JAVA3, this::setUseRxJava3);
335335
convertPropertyToBooleanAndWriteBack(USE_RX_JAVA2, this::setUseRxJava2);
336336
}
337-
convertPropertyToBooleanAndWriteBack(CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, this::setUseSingleRequestParameter);
337+
convertPropertyToStringAndWriteBack(CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, this::setUseSingleRequestParameter);
338+
writePropertyBack("singleRequestParameter", getSingleRequestParameter());
339+
writePropertyBack("staticRequest", getStaticRequest());
338340

339341
if (!useRxJava && !useRxJava2 && !useRxJava3) {
340342
additionalProperties.put(DO_NOT_USE_RX, true);
@@ -757,7 +759,7 @@ public void processOpts() {
757759
public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
758760
super.postProcessOperationsWithModels(objs, allModels);
759761

760-
if (useSingleRequestParameter && (JERSEY2.equals(getLibrary()) || JERSEY3.equals(getLibrary()) || OKHTTP_GSON.equals(getLibrary()))) {
762+
if (this.getSingleRequestParameter() && (JERSEY2.equals(getLibrary()) || JERSEY3.equals(getLibrary()) || OKHTTP_GSON.equals(getLibrary()))) {
761763
// loop through operations to set x-group-parameters extension to true if useSingleRequestParameter option is enabled
762764
OperationMap operations = objs.getOperations();
763765
if (operations != null) {
@@ -1116,7 +1118,15 @@ public boolean getUseOneOfDiscriminatorLookup() {
11161118
return this.useOneOfDiscriminatorLookup;
11171119
}
11181120

1119-
private boolean getUseSingleRequestParameter() {
1121+
public boolean getSingleRequestParameter() {
1122+
return "true".equals(getUseSingleRequestParameter()) || "static".equals(getUseSingleRequestParameter());
1123+
}
1124+
1125+
public boolean getStaticRequest() {
1126+
return "static".equals(this.getUseSingleRequestParameter());
1127+
}
1128+
1129+
private String getUseSingleRequestParameter() {
11201130
return useSingleRequestParameter;
11211131
}
11221132

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ public interface {{classname}} {
7171
{{#hasProduces}}
7272
@Produces({ {{#produces}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/produces}} })
7373
{{/hasProduces}}
74-
{{^useSingleRequestParameter}}
74+
{{^singleRequestParameter}}
7575
{{^vendorExtensions.x-java-is-response-void}}{{#microprofileServer}}{{> server_operation}}{{/microprofileServer}}{{^microprofileServer}}{{> client_operation}}{{/microprofileServer}}{{/vendorExtensions.x-java-is-response-void}}{{#vendorExtensions.x-java-is-response-void}}{{#microprofileMutiny}}Uni<Void>{{/microprofileMutiny}}{{^microprofileMutiny}}void{{/microprofileMutiny}}{{/vendorExtensions.x-java-is-response-void}} {{nickname}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{^-last}}, {{/-last}}{{/allParams}}) throws ApiException, ProcessingException;
76-
{{/useSingleRequestParameter}}
77-
{{#useSingleRequestParameter}}
76+
{{/singleRequestParameter}}
77+
{{#singleRequestParameter}}
7878
{{^vendorExtensions.x-java-is-response-void}}{{#microprofileMutiny}}Uni<{{{returnType}}}>{{/microprofileMutiny}}{{^microprofileMutiny}}{{{returnType}}}{{/microprofileMutiny}}{{/vendorExtensions.x-java-is-response-void}}{{#vendorExtensions.x-java-is-response-void}}{{#microprofileMutiny}}Uni<Void>{{/microprofileMutiny}}{{^microprofileMutiny}}void{{/microprofileMutiny}}{{/vendorExtensions.x-java-is-response-void}} {{nickname}}({{#hasNonBodyParams}}@BeanParam {{operationIdCamelCase}}Request request{{/hasNonBodyParams}}{{#bodyParams}}{{#hasNonBodyParams}}, {{/hasNonBodyParams}}{{>bodyParams}}{{/bodyParams}}) throws ApiException, ProcessingException;
7979
{{#hasNonBodyParams}}
8080
public class {{operationIdCamelCase}}Request {
@@ -114,7 +114,7 @@ public interface {{classname}} {
114114
{{/allParams}}
115115
}
116116
{{/hasNonBodyParams}}
117-
{{/useSingleRequestParameter}}
117+
{{/singleRequestParameter}}
118118
{{/operation}}
119119
}
120120
{{/operations}}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public class {{classname}} {
5252
}
5353

5454
{{#operation}}
55-
{{#useSingleRequestParameter}}
55+
{{#singleRequestParameter}}
5656
{{#hasParams}}
5757
{{^hasSingleParam}}
5858

@@ -108,7 +108,7 @@ public class {{classname}} {
108108

109109
{{/hasSingleParam}}
110110
{{/hasParams}}
111-
{{/useSingleRequestParameter}}
111+
{{/singleRequestParameter}}
112112
/**
113113
* {{summary}}
114114
* {{notes}}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ public class {{classname}} {
5353
this.apiClient = apiClient;
5454
}
5555

56-
{{#operation}}{{#useSingleRequestParameter}}{{#hasParams}}{{^hasSingleParam}}
57-
public class {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request {
56+
{{#operation}}{{#singleRequestParameter}}{{#hasParams}}{{^hasSingleParam}}
57+
public {{#staticRequest}}static {{/staticRequest}}class {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request {
5858
{{#allParams}}
5959
private final {{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection<org.springframework.core.io.AbstractResource>{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}};
6060
{{/allParams}}
@@ -120,7 +120,7 @@ public class {{classname}} {
120120
return this.{{operationId}}WithResponseSpec({{#allParams}}requestParameters.{{paramName}}(){{^-last}}, {{/-last}}{{/allParams}});
121121
}
122122

123-
{{/hasSingleParam}}{{/hasParams}}{{/useSingleRequestParameter}}
123+
{{/hasSingleParam}}{{/hasParams}}{{/singleRequestParameter}}
124124
/**
125125
* {{summary}}
126126
* {{notes}}

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

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3187,7 +3187,7 @@ public void testRestClientWithUseSingleRequestParameter_issue_19406() {
31873187
.setLibrary(JavaClientCodegen.RESTCLIENT)
31883188
.setAdditionalProperties(Map.of(
31893189
CodegenConstants.API_PACKAGE, "xyz.abcdef.api",
3190-
CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, true
3190+
CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, "true"
31913191
))
31923192
.setInputSpec("src/test/resources/3_1/java/petstore.yaml")
31933193
.setOutputDir(output.toString().replace("\\", "/"));
@@ -3215,7 +3215,7 @@ public void testDuplicatedOperationId() {
32153215
.setLibrary(JavaClientCodegen.RESTCLIENT)
32163216
.setAdditionalProperties(Map.of(
32173217
CodegenConstants.API_PACKAGE, "xyz.abcdef.api",
3218-
CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, true
3218+
CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, "true"
32193219
))
32203220
.setInputSpec("src/test/resources/3_0/duplicated_operationid.yaml")
32213221
.setOutputDir(output.toString().replace("\\", "/"));
@@ -3250,7 +3250,7 @@ public void testDuplicatedOperationId() {
32503250
.setLibrary(JavaClientCodegen.WEBCLIENT)
32513251
.setAdditionalProperties(Map.of(
32523252
CodegenConstants.API_PACKAGE, "xyz.abcdef.api",
3253-
CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, true
3253+
CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, "true"
32543254
))
32553255
.setInputSpec("src/test/resources/3_1/java/petstore.yaml")
32563256
.setOutputDir(output.toString().replace("\\", "/"));
@@ -3272,6 +3272,35 @@ public void testDuplicatedOperationId() {
32723272
);
32733273
}
32743274

3275+
@Test public void testWebClientWithUseSingleRequestParameter_static() {
3276+
final Path output = newTempFolder();
3277+
final CodegenConfigurator configurator = new CodegenConfigurator()
3278+
.setGeneratorName("java")
3279+
.setLibrary(JavaClientCodegen.WEBCLIENT)
3280+
.setAdditionalProperties(Map.of(
3281+
CodegenConstants.API_PACKAGE, "xyz.abcdef.api",
3282+
CodegenConstants.USE_SINGLE_REQUEST_PARAMETER, "static"
3283+
))
3284+
.setInputSpec("src/test/resources/3_1/java/petstore.yaml")
3285+
.setOutputDir(output.toString().replace("\\", "/"));
3286+
3287+
new DefaultGenerator().opts(configurator.toClientOptInput()).generate();
3288+
3289+
TestUtils.assertFileContains(
3290+
output.resolve("src/main/java/xyz/abcdef/api/PetApi.java"),
3291+
"public static class DeletePetRequest {",
3292+
"DeletePetRequest(Long petId, String apiKey)",
3293+
"Long petId()",
3294+
"String apiKey()",
3295+
"public Mono<Void> deletePet(DeletePetRequest requestParameters) throws WebClientResponseException {",
3296+
"public Mono<ResponseEntity<Void>> deletePetWithHttpInfo(DeletePetRequest requestParameters) throws WebClientResponseException {",
3297+
"public ResponseSpec deletePetWithResponseSpec(DeletePetRequest requestParameters) throws WebClientResponseException {",
3298+
"public Mono<Void> deletePet(Long petId, String apiKey) throws WebClientResponseException {",
3299+
"public Mono<ResponseEntity<Void>> deletePetWithHttpInfo(Long petId, String apiKey) throws WebClientResponseException {",
3300+
"public ResponseSpec deletePetWithResponseSpec(Long petId, String apiKey) throws WebClientResponseException {"
3301+
);
3302+
}
3303+
32753304
@Test
32763305
public void testGenerateParameterId() {
32773306
final Path output = newTempFolder();

0 commit comments

Comments
 (0)