Skip to content

Conversation

Mattias-Sehlstedt
Copy link
Contributor

Adds support for Json-serialized query parameters.

A query parameter with an array/object/array of objects is most often serialized based upon the explode and style settings. Another less common way of formatting query parameters is by stating that they should be Json-serialized.

Since the RestClient and WebClient were already using an ObjectMapper, I configured so that that is used to serialize any query parameter. This should also mean that it should be easy for a client to adjust a parameter's serialization if the case is that the server does not want the "standard" serialization format that one would expect for an object (i.e., you can inject a custom Json-serialization for any query-object you might have).

I have tested the basic case of a single object and an array of objects in a local project by mirroring the mustache-file changes that I have committed here.

PR checklist

  • Read the contribution guidelines.
  • 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.
  • 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.
  • 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)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@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)

@Mattias-Sehlstedt Mattias-Sehlstedt marked this pull request as ready for review August 11, 2025 15:34
@wing328 wing328 merged commit 4d9fd4d into OpenAPITools:master Aug 12, 2025
107 checks passed
@Mattias-Sehlstedt Mattias-Sehlstedt deleted the spring-client-json-encoded-query-parameter branch August 16, 2025 13:01
@wing328 wing328 added this to the 7.15.0 milestone Aug 22, 2025
Goopher pushed a commit to Goopher/openapi-generator that referenced this pull request Sep 9, 2025
…and WebClient (OpenAPITools#21725)

* Add so that a query parameter can be serialized as Json in the Spring clients RestClient and WebClient

* Update samples

* Add clientCodeGen test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants