refactor: [OpenAPI] Part 1: Refactor Apache related files and templates #1048
Conversation
- 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
| return this; | ||
| } | ||
| return fromHttpClient((CloseableHttpClient) ApacheHttpClient5Accessor.getHttpClient(destination)) | ||
| .withBasePath(destination.asHttp().getUri().toString()); |
There was a problem hiding this comment.
(Minor)
I'm not sure whether the following is unnecessary: withBasePath(destination.asHttp().getUri().toString())
unit tests will show.
There was a problem hiding this comment.
It is neccessary, otherwise we will have DEFAULT_BASE_PATH as basePath.
| import lombok.Value; | ||
| import lombok.With; | ||
|
|
||
| @Value |
There was a problem hiding this comment.
(Minor)
Happy about making it an immuatable class!
Unfortunately it's final implicitly, meaning it can never be customized e.g. for future workarounds. Potential solution could be non-value or introduction of interface.
There was a problem hiding this comment.
I made the class almost @Value by making the class non-final.
| protected DateFormat dateFormat; | ||
| @With | ||
| @Nullable | ||
| String tempFolderPath; |
There was a problem hiding this comment.
(Minor)
You mentioned you want this field to have public getter (?)
There was a problem hiding this comment.
Only basePath has a getter right now. tempFolderPath is null by default.
| * {{#appDescription}}{{{appDescription}}}{{/appDescription}}{{^appDescription}}No description provided.{{/appDescription}} | ||
| */ | ||
| {{!>generatedAnnotation}} | ||
| {{^isReleased}}@Beta{{/isReleased}} |
There was a problem hiding this comment.
(Minor)
Please use fully-qualified-name for optional (deendency) anotations, e.g.
@com.google.common.annotations.Beta
rpanackal
changed the title
- Make ApiClient almost `@Value` - fix url building with "//" - Fix vulnerabilities of payload leak in exception messages
…factor-apache-templates
...main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/api.mustache
Outdated
Show resolved
Hide resolved
...main/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/api.mustache
Outdated
Show resolved
Hide resolved
.../openapi/openapi-core/src/main/java/com/sap/cloud/sdk/services/openapi/apache/ApiClient.java
Outdated
Show resolved
Hide resolved
| return this; | ||
| } | ||
| return fromHttpClient((CloseableHttpClient) ApacheHttpClient5Accessor.getHttpClient(destination)) | ||
| .withBasePath(destination.asHttp().getUri().toString()); |
There was a problem hiding this comment.
It is neccessary, otherwise we will have DEFAULT_BASE_PATH as basePath.
| import lombok.Value; | ||
| import lombok.With; | ||
|
|
||
| @Value |
There was a problem hiding this comment.
I made the class almost @Value by making the class non-final.
| protected DateFormat dateFormat; | ||
| @With | ||
| @Nullable | ||
| String tempFolderPath; |
There was a problem hiding this comment.
Only basePath has a getter right now. tempFolderPath is null by default.
newtork
left a comment
newtork
left a comment
There was a problem hiding this comment.
Looks good!
As discussed we'll have a follow up for:
- tests - see Part 2 PR
- response headers + code - wip
Context
SAP/cloud-sdk-java-backlog#464.
The parent PR contains all files as they would be if we purely relied on generation via OpenAPI code generator with commonly generated files packages with
openapi-coremodule.The scope of this PR is to reduce public API, achieve feature parity with resttemplate based generation and refactoring code for readability.
Feature scope:
auth/*.javafiles - We support authentication via destinationApiExceptionremoved in favour existingOpenApiRequestException(modified)ServerConfiguration,ServerVariable,StringUtilremoved as we do not support single client instance pointing to multi urlsapiClient/RFC3339DateFormatBaseApiImprovements in
ApiClientdefaultHeaderMaps: headers expected to be set request level, destination header provider or customClosableHttpClientdefaultCookieMap: no cookie supportservers,serverIndex,serverVariables: only singlebaseUrlsupportlastStatusCode,lastResponseHeaders: Removed due to feature engineering concerns. To compensate, new api introduced inOpenApiRequestExceptionand newOpenApiResponse.debuggingflag,connectionTimeout: useless and to be configured elsewhere.cookieParamsandauthNamesthat sets request level configuration for cookies and authorization (but unused) are removed frominvokeAPIsignature@Betaon jackson exposing apistaticDefaultApiResponseHandler@ValueclassExceptionmessagesFeature Parity with resttemplate (template modifications)
finalon local vars, parameters, returns as appropriate.x-sap-cloud-sdk-operation-name,x-return-nullableapache/OpenApiResponseinstead ofvoidas return type for remote calls. Existingcore/OpenApiResponsehas Spring components in public contract. 😿Definition of Done
Error handling created / updated & covered by the tests aboveDocumentation updatedRelease notes updated