feat: [OpenAPI] Part 2: Testing Apache Client Support and some fixes. #1062
+10,927
−479
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- no more shared client in *Api.java instances
… apiclient package
- *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
commented
Jan 8, 2026
| * @throws OpenApiRequestException | ||
| * if an error occurs while attempting to invoke the API | ||
| */ | ||
| @Nonnull |
Member
Author
There was a problem hiding this comment.
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
Contributor
There was a problem hiding this comment.
Because there is no chance we get a null on anything but a 204
…factor-apache-templates
…pi/test-apache-client-templates
newtork
reviewed
Jan 9, 2026
...rc/test/java/com/sap/cloud/sdk/services/openapi/genericreturntype/GenericReturnTypeTest.java
Show resolved
Hide resolved
newtork
reviewed
Jan 9, 2026
| }); | ||
|
|
||
| // Always disable supportUrlQuery as it's not compatible with interface generation | ||
| result.put(SUPPORT_URL_QUERY, "false"); |
Contributor
There was a problem hiding this comment.
(Question)
This looks surprising. Will this not result in a breaking change? What is this flag doing?
Member
Author
There was a problem hiding this comment.
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
reviewed
Jan 9, 2026
| //TODO: support byte[] for files? Do via review | ||
| // final byte[] result = sut.sodasDownloadIdGet(1L); | ||
| // assertThat(result).isNotNull(); | ||
| // assertThat(result).isEqualTo(binaryData); |
Contributor
There was a problem hiding this comment.
(Minor)
We may need an additional unit test for that(?)
Member
Author
There was a problem hiding this comment.
We do have support for byte[], unlike what I initially though was the case. So I uncommented the test here.
newtork
reviewed
Jan 9, 2026
...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
…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
Jonas-Isr
reviewed
Jan 12, 2026
...sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/OneOfDeserializationTest.java
Show resolved
Hide resolved
...apache-sample/src/test/java/com/sap/cloud/sdk/services/openapi/apache/SerializationTest.java
Show resolved
Hide resolved
...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
…st-apache-client-templates # Conflicts: # datamodel/openapi/openapi-generator/src/main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/api.mustache
…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
Outdated
Show resolved
Hide resolved
…st-apache-client-templates # Conflicts: # datamodel/openapi/openapi-generator/src/main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/operationBody.mustache
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
SAP/cloud-sdk-java-backlog#464.
Helpful Links:
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:
openapi-coreopenapi-api-apache-samplemoduleopenapi-generator<supportUrlQuery>false</supportUrlQuery>by hard coding it into the generatorDefinition of Done
Error handling created / updated & covered by the tests aboveDocumentation updatedRelease notes updated