SpringDoc Problem With Methods With Different Query Parameters

Question

I want to do something like create two method for same url pattern with different arguments

@RequestMapping(value = "/searchUser", params = "userID")
public String searchUserById(@RequestParam long userID, Model model) {
  // ...
}

@RequestMapping(value = "/searchUser", params = "userName")
public ModelAndView searchUserByName(@RequestParam String userName) {
  // ...
}

Spring supports this and it works fine. SpringDoc does not. It creates a single endpoint with 2 parameters.Is this a known issue?

Have you found solution to this? I have same issue with @GetMapping methods having same path but different @RequestParam — pixel
– pixel, Commented Jun 21, 2022 at 18:05

brianbro · Accepted Answer · 2021-12-26 20:31:14Z

1

This is supported, but you will have to use swagger @Operation to describe your methods in one path.

One of the OpenAPI 3 rules.

Two POST methods for the same path are not allowed – even if they have different parameters (parameters have no effect on uniqueness).

More details are available on OpenAPI 3 site.

This has been explained here: https://github.com/springdoc/springdoc-openapi/issues/580

answered Dec 26, 2021 at 20:31

brianbro

4,9473 gold badges29 silver badges43 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

pixel Over a year ago

Nothing to do with POST methods. Same with @GetMapping

Igor Over a year ago

This honestly sucks. The OAS3 spec is dumb in this regard.

Collectives™ on Stack Overflow

SpringDoc Problem With Methods With Different Query Parameters

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related