feat: [OpenAPI] Part 2: Testing Apache Client Support and some fixes. by rpanackal · Pull Request #1062 · SAP/cloud-sdk-java

rpanackal · 2026-01-07T13:44:57Z

Context

SAP/cloud-sdk-java-backlog#464.
Helpful Links:

refactor: [OpenAPI] Part 1: Refactor Apache related files and templates #1048

In the previous PR, we introduced OpenAPI generator support for apache-httpclient template library, effectively making Spring options.

In this PR, there exists the test coverage for the new components equivalent to Spring.

Feature scope:

Unit testing in openapi-core
Test serialization, deserialization and oneOf support in openapi-api-apache-sample module
Integration testing in openapi-generator
Pin <supportUrlQuery>false</supportUrlQuery> by hard coding it into the generator

Definition of Done

Functionality scope stated & covered
Tests cover the scope above
~~Error handling created / updated & covered by the tests above~~
~~Documentation updated~~
~~Release notes updated~~

- no more shared client in *Api.java instances

… apiclient package

…eAPI`

- *Api.invoke method bugged and unused

- Remove debugging, connectionTimeout, defaultHeaderMap, defaultCookieMap - add TODOs - public setBasePath - Remove addDefaultHeader, setUserAgent,

- Make as manny methods static - Remove deprecated getStatusCode and getResponseHeaders - public parameterToPairs

- Make as many methods static - rename ApiClientResponseHandler to DefaultApiResponseHandler - finish up ApiClient todos

- Enhance JavaDoc - Support Vendor extension `x-sap-cloud-sdk-operation-name`

- Method overloading for required and options param in operations

- final on local vars

…-apache-templates

…pi/test-apache-client-templates

- Hide response body from exception message - regenerate with formatting adjustments - Non-null response when return type is OpenApiResponse. - invokeAPI is nullable

- Make ApiClient almost `@Value` - fix url building with "//" - Fix vulnerabilities of payload leak in exception messages

rpanackal · 2026-01-07T15:07:52Z

...sample/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/petstore/api/DefaultApi.java

+     * @throws OpenApiRequestException
+     *             if an error occurs while attempting to invoke the API
+     */
+    @Nonnull


This @Nonull annotaion is a lie. The same exists in Spring equivalent.

I am assuming this was intentional to not force handling possible null value at the caller. Still, would like some confirmation.

To add some details, invokeAPI() calls will return null when response body is empty or status is. 204

Because there is no chance we get a null on anything but a 204

Fix @Nonnull and @Nullable annotations on endpoint methods created by OpenAPI Generator #511

…factor-apache-templates

…pi/test-apache-client-templates

...rc/test/java/com/sap/cloud/sdk/services/openapi/genericreturntype/GenericReturnTypeTest.java

newtork · 2026-01-09T18:17:37Z

...ain/java/com/sap/cloud/sdk/datamodel/openapi/generator/GenerationConfigurationConverter.java

        });
+
+        // Always disable supportUrlQuery as it's not compatible with interface generation
+        result.put(SUPPORT_URL_QUERY, "false");


(Question)

This looks surprising. Will this not result in a breaking change? What is this flag doing?

This flag adds a method like toUrlQueryString() onto all model classes. Basically, it serializes a model class's instance into a output to be appended on the url of GET request. I don't recall the detals anymore.

The conversion to url string involves a chain of toUrlQueryString() invocation for each field. But some fields may be of interface type, leading to compilation error.

The feature supportUrlQuery is specific to only apache and native client. So it doesn't break any expectation for existing spring users.

newtork · 2026-01-09T18:20:29Z

...ache-sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/DeserializationTest.java

+        //TODO: support byte[] for files? Do via review
+        //        final byte[] result = sut.sodasDownloadIdGet(1L);
+        //        assertThat(result).isNotNull();
+        //        assertThat(result).isEqualTo(binaryData);


(Minor)

We may need an additional unit test for that(?)

We do have support for byte[], unlike what I initially though was the case. So I uncommented the test here.

...apache-sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/SerializationTest.java

…factor-apache-templates # Conflicts: # datamodel/openapi/openapi-api-apache-sample/pom.xml # datamodel/openapi/openapi-api-apache-sample/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/sample/api/OrdersApi.java # datamodel/openapi/openapi-api-apache-sample/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/sample/api/SodasApi.java # datamodel/openapi/openapi-core/src/main/java/com/sap/cloud/sdk/services/openapi/apache/ApiClient.java # datamodel/openapi/openapi-core/src/main/java/com/sap/cloud/sdk/services/openapi/apache/BaseApi.java # datamodel/openapi/openapi-core/src/main/java/com/sap/cloud/sdk/services/openapi/apache/DefaultApiResponseHandler.java # datamodel/openapi/openapi-core/src/main/java/com/sap/cloud/sdk/services/openapi/apache/Pair.java

…pi/test-apache-client-templates # Conflicts: # datamodel/openapi/openapi-api-apache-sample/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/petstore/api/DefaultApi.java # datamodel/openapi/openapi-api-apache-sample/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/petstore/model/ErrorModel.java # datamodel/openapi/openapi-api-apache-sample/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/petstore/model/Pet.java # datamodel/openapi/openapi-api-apache-sample/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/petstore/model/PetInput.java # datamodel/openapi/openapi-api-apache-sample/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/sodastore/model/ColaBarCode.java

...sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/OneOfDeserializationTest.java

...apache-sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/SerializationTest.java

...e/src/test/java/com/sap/cloud/sdk/datamodel/openapi/sample/api/OneOfDeserializationTest.java

...est/java/com/sap/cloud/sdk/services/openapi/apiclient/ApacheApiClientViaConstructorTest.java

…st-apache-client-templates # Conflicts: # datamodel/openapi/openapi-generator/src/main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/api.mustache

...rces/openapi-generator/mustache-templates/libraries/apache-httpclient/operationBody.mustache

…st-apache-client-templates # Conflicts: # datamodel/openapi/openapi-generator/src/main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/operationBody.mustache

rpanackal added 30 commits December 30, 2025 10:36

regenerate with prompt-registry.yaml

7aed42d

regenerate with prompt-registry.yaml

d4747ad

Remove ServerVariable.java and ServerConfiguration.java files

03933a0

NoArgs ctor preserved but remove Configuration

27cc015

- no more shared client in *Api.java instances

Remove apache specific date classes addition. Reuse existing class in…

112360d

… apiclient package

Pair - Simplify and improve code quality

a9e609b

Remove Authentication classes and authNames from `ApiClient.invok…

2f684c6

…eAPI`

make unimported methods private and use ApacheHttpClient5Accessor

aa60080

Remove invokeAPI methods in BaseApi and *Api.java

73ffecc

- *Api.invoke method bugged and unused

Refactoring ApiClient

f4358bc

- Remove debugging, connectionTimeout, defaultHeaderMap, defaultCookieMap - add TODOs - public setBasePath - Remove addDefaultHeader, setUserAgent,

Refactoring ApiClient

3ce5400

- Make as manny methods static - Remove deprecated getStatusCode and getResponseHeaders - public parameterToPairs

Fix dependency and warning

ad8a738

Remove method overloading per operation with additionalHeaders

d8add74

Extract response handling out of ApiClient into ApiClientResponseHandler

0c0176c

Make static ApiClient ctors

db04109

- Make as many methods static - rename ApiClientResponseHandler to DefaultApiResponseHandler - finish up ApiClient todos

Remove ApiException and use enhanced OpenApiRequestException

ffada46

Borrow sample module handling

cd26cf8

Apache mustache parity

8357f5f

- Enhance JavaDoc - Support Vendor extension `x-sap-cloud-sdk-operation-name`

Apache mustache parity

4d5b97b

- Method overloading for required and options param in operations

Apache mustache parity and object mapper config

e1390af

- final on local vars

Revert to sodastore generation in sample

97c5e03

Add apache/OpenApiResponse instead of void returns

59fedb1

Remove guava dependency

c5cba53

Update apache pom for general and generator configuration

e6ec8b9

Generate and test sodastore and petstore

f16b2c9

Merge remote-tracking branch 'origin/main' into feat/openapi/refactor…

1b4ffcb

…-apache-templates

Merge branch 'feat/openapi/refactor-apache-templates' into feat/opena…

c56376c

…pi/test-apache-client-templates

Extending existing integration test

0773674

Complete and cleanup integration test

943de3c

Make url building more forgiving

cc08bfb

- Hide response body from exception message - regenerate with formatting adjustments - Non-null response when return type is OpenApiResponse. - invokeAPI is nullable

Borrow downstream PR changes

eb21453

- Make ApiClient almost `@Value` - fix url building with "//" - Fix vulnerabilities of payload leak in exception messages

rpanackal commented Jan 8, 2026

View reviewed changes

rpanackal added 2 commits January 8, 2026 11:55

Merge branch 'feat/openapi/optional-spring-base' into feat/openapi/re…

acff1d1

…factor-apache-templates

Merge branch 'feat/openapi/refactor-apache-templates' into feat/opena…

9f00a54

…pi/test-apache-client-templates

rpanackal self-assigned this Jan 8, 2026

rpanackal added the please review Request to review a pull request label Jan 8, 2026

newtork reviewed Jan 9, 2026

View reviewed changes

...rc/test/java/com/sap/cloud/sdk/services/openapi/genericreturntype/GenericReturnTypeTest.java Show resolved Hide resolved

newtork reviewed Jan 9, 2026

View reviewed changes

...apache-sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/SerializationTest.java Outdated Show resolved Hide resolved

Base automatically changed from feat/openapi/refactor-apache-templates to feat/openapi/optional-spring-base January 12, 2026 09:42

rpanackal added 6 commits January 12, 2026 14:02

Merging

0a71d8e

Merging

a84b2ca

Fix serialization of null and

476fef7

fix byte[] test and pmd

5884d6e

Jonas-Isr reviewed Jan 12, 2026

View reviewed changes

...sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/OneOfDeserializationTest.java Show resolved Hide resolved

fix oneOf serialization test

5f61ebf

CharlesDuboisSAP reviewed Jan 13, 2026

View reviewed changes

...apache-sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/SerializationTest.java Show resolved Hide resolved

CharlesDuboisSAP reviewed Jan 13, 2026

View reviewed changes

...e/src/test/java/com/sap/cloud/sdk/datamodel/openapi/sample/api/OneOfDeserializationTest.java Show resolved Hide resolved

...est/java/com/sap/cloud/sdk/services/openapi/apiclient/ApacheApiClientViaConstructorTest.java Outdated Show resolved Hide resolved

rpanackal added 3 commits January 14, 2026 14:10

Merge branch 'feat/openapi/optional-spring-base' into feat/openapi/te…

16f26ab

…st-apache-client-templates # Conflicts: # datamodel/openapi/openapi-generator/src/main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/api.mustache

Merge branch 'feat/openapi/optional-spring-base' into feat/openapi/te…

4cf87b9

…st-apache-client-templates # Conflicts: # datamodel/openapi/openapi-generator/src/main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/api.mustache

Reeview changes

d8bc954

CharlesDuboisSAP reviewed Jan 15, 2026

View reviewed changes

...rces/openapi-generator/mustache-templates/libraries/apache-httpclient/operationBody.mustache Outdated Show resolved Hide resolved

rpanackal added 2 commits January 15, 2026 16:39

Merge branch 'feat/openapi/optional-spring-base' into feat/openapi/te…

3b44637

…st-apache-client-templates # Conflicts: # datamodel/openapi/openapi-generator/src/main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/operationBody.mustache

Merge changes and regenerate (minor)

3ac5e85

rpanackal merged commit 859a8f1 into feat/openapi/optional-spring-base Jan 15, 2026
3 checks passed

rpanackal deleted the feat/openapi/test-apache-client-templates branch January 15, 2026 15:47

rpanackal mentioned this pull request Jan 15, 2026

feat: [OpenAPI] Make Spring Optional with Apache HttpClient #1046

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [OpenAPI] Part 2: Testing Apache Client Support and some fixes.#1062

feat: [OpenAPI] Part 2: Testing Apache Client Support and some fixes.#1062
rpanackal merged 51 commits intofeat/openapi/optional-spring-basefrom
feat/openapi/test-apache-client-templates

rpanackal commented Jan 7, 2026 •

edited

Loading

Uh oh!

rpanackal Jan 7, 2026 •

edited

Loading

Uh oh!

CharlesDuboisSAP Jan 13, 2026

Uh oh!

Uh oh!

newtork Jan 9, 2026

Uh oh!

rpanackal Jan 12, 2026 •

edited

Loading

Uh oh!

newtork Jan 9, 2026

Uh oh!

rpanackal Jan 13, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

rpanackal commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Feature scope:

Definition of Done

Uh oh!

rpanackal Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CharlesDuboisSAP Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

newtork Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

rpanackal Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

newtork Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

rpanackal Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rpanackal commented Jan 7, 2026 •

edited

Loading

rpanackal Jan 7, 2026 •

edited

Loading

rpanackal Jan 12, 2026 •

edited

Loading