SpringDoc对同URL不同请求参数的接口处理异常是否为已知问题?
关于同URL不同参数接口被SpringDoc合并的说明
这是SpringDoc的默认设计行为,并非未知bug。
SpringDoc默认以「HTTP请求方法 + URL路径」作为接口的唯一识别标识,不会默认读取@RequestMapping注解中的params属性作为区分条件,因此你示例中两个路径均为/searchUser、默认请求方法为GET的接口,会被识别为同一个端点,同时聚合两个方法的入参进行展示。
修复方案
方案一:单个接口标注区分
为两个方法分别添加@Operation注解,指定不同的operationId,即可强制SpringDoc将二者识别为独立端点:
@RequestMapping(value = "/searchUser", params = "userID") @Operation(operationId = "searchUserById") public String searchUserById(@RequestParam long userID, Model model) { // 业务逻辑 } @RequestMapping(value = "/searchUser", params = "userName") @Operation(operationId = "searchUserByName") public ModelAndView searchUserByName(@RequestParam String userName) { // 业务逻辑 }
你还可以配合@Parameter注解标注每个接口仅支持的请求参数,让文档展示更清晰。
方案二:全局配置区分
如果需要批量处理同类场景,可以修改SpringDoc全局配置,将请求参数params纳入接口唯一标识的判断维度,即可自动区分所有同路径不同参数的接口,该方案会影响项目所有接口的文档生成逻辑,建议按需选择。
内容的提问来源于stack exchange,提问作者Mike Rother
相关产品推荐
相关产品推荐

