openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[java][okhttp-gson] fix: JSON deserialization fallback for `String` return types

Open klin1344 opened this issue 1 month ago • 1 comments

This change is a follow-up to #21115, the fix for kubernetes-client/java#4020.

The original change switched deserialization to be InputStream-based, which no longer falls back to returning the raw String on JsonParseException when the return type is String.class:

https://github.com/OpenAPITools/openapi-generator/blob/2c7efda060f64aed0b3afd52fc2247e5180b35e0/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/JSON.mustache#L193-L201

We cannot implement the same fallback for InputStream-based deserialization because an InputStream can only be consumed once. If JSON parsing fails, we cannot rewind the stream to return the raw content.

Fix: In ApiClient, check the return type before choosing the deserialization path. If it is String.class, use String-based JSON.deserialize(String, Type) with fallback behavior. For all other types, use the InputStream-based JSON.deserialize(InputStream, Type) for streaming which supports responses > 2GB.

This preserves backward compatibility for the fallback behavior - when JSON parsing fails and the return type is String.class, the raw response body is returned as a String instead of throwing JsonParseException.

PR checklist

  • [x] Read the contribution guidelines.
  • [x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL) Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [x] File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [x] If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

klin1344 avatar Dec 06 '25 05:12 klin1344

cc @lhotari

klin1344 avatar Dec 06 '25 05:12 klin1344

thanks for the PR

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

let's give it a try

wing328 avatar Dec 11 '25 06:12 wing328