chore: [OpenAPI] Reduce Spring dependency #754
8000
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
# Conflicts: # datamodel/openapi/openapi-api-sample/pom.xml # datamodel/openapi/openapi-api-sample/src/test/java/com/sap/cloud/sdk/datamodel/openapi/sample/api/OneOfDeserializationTest.java
newtork
commented
Mar 14, 2025
| * @return The response body in chosen type | ||
| * @throws OpenApiRequestException | ||
| * Thrown in case an exception occurs during invocation of the REST API | ||
| */ | ||
| @SuppressWarnings( "unchecked" ) | ||
| @Nullable | ||
| public <T> T invokeAPI( |
There was a problem hiding this comment.
(Comment)
Weaken API contract to allow non-Spring arguments:
Update in usage:
First step:
- Remove Spring requirement from public API.
- No breaking change with existing generated code.
- Code quality must still be improved though: Deprecation, Replacement, Delegation.
Next step:
- Improve code by offering an implementation for
invokeAPIthat does not require transitive Spring dependencies. While keeping legacy consumers unaffected on API contract.
newtork
commented
Mar 14, 2025
Comment on lines
62
to
-68
| <dependency> | ||
| <groupId>org.springframework</groupId> | ||
| <artifactId>spring-core</artifactId> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.springframework</groupId> | ||
| <artifactId>spring-web</artifactId> |
There was a problem hiding this comment.
(Comment)
For the users, this is already a significant improvement!
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
https://github.com/SAP/cloud-sdk-java-backlog/issues/464
We want to reduce the Spring dependency.
Currently:
org.springframework:spring-core::compileorg.springframework:spring-web::compileExpected (1):
org.springframework:spring-core::compileorg.springframework:spring-web::compileExpected (2):
org.springframework:spring-core::compileorg.springframework:spring-web::compileFeature scope:
Update mustache file to reduce Spring types from public API (70%)
openapi-coreAPI contract to allow for non-Spring typed argumentsHarden and improve
openapi-coreAPI contractoptional-scoped dependencies.Update mustache file to use recommended API
Definition of Done
Error handling created / updated & covered by the tests aboveDocumentation updated