具有不同查询参数的方法的 SpringDoc 问题答案

【问题标题】：SpringDoc Problem With Methods With Different Query Parameters具有不同查询参数的方法的 SpringDoc 问题
【发布时间】：2021-09-18 19:50:58
【问题描述】：

我想做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 支持这一点并且工作正常。 SpringDoc 没有。它使用 2 个参数创建一个端点。这是一个已知问题吗？

【问题讨论】：

标签： spring-restcontroller springdoc

【解决方案1】：

这是受支持的，但您必须使用 swagger @Operation 来描述您的方法在一个路径中。

OpenAPI 3 规则之一。

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

更多详情请参见 OpenAPI 3 site。

这里已经解释过了：https://github.com/springdoc/springdoc-openapi/issues/580

【讨论】：