OpenAPITools / OpenAPITools/openapi-generator

[REQ] Support (Spring)QueryMap

Open
#17,334 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

We have requests that have like a dozen parameters/headers, a method with a dozen parameters is bad design and unreadable when they're all strings.

Describe the solution you'd like

When using spring -> spring-cloud (I suspect java -> feign as well) I'd like to be able to generate parameters with custom objects https://docs.spring.io/spring-cloud-openfeign/docs/current/reference/html/#feign-querymap-support

I believe @HeaderMap does much of the same thing, I also think Spring may have it's own version of it as well https://javadoc.io/doc/io.github.openfeign/feign-core/11.6/feign/HeaderMap.html

Describe alternatives you've considered

not using generated code

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Spring Cloud OpenFeign QueryMap reference and Feign's HeaderMap support mentioned in the issue, then locate the Java client generation path that handles method parameters. Define how custom objects should become query parameters and which generated-client tests should verify the behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.