Swagger@ApiParam注释使得在Swagger UI中不需要使用@Path变量注释的参数

Question

我有以下代码，这是我的API的艺术

    import org.springframework.web.bind.annotation.PathVariable;
    import io.swagger.annotations.*;

    @GetMapping(value = "/{userId}")
        public String getUserHistory(ApiParam(value = "The user id") 
                    @PathVariable("userId") Integer userId, Model model) throws NotFoundException {
            // fetch user info
            model.addAttribute("userInfo", userInfo);
            return "userHistory";
        }

如果我有@ApiParam注释，@PathVariable就变成非必需的，所以如果我没有输入userId并通过Swagger UI发出请求，请求仍然会转到服务器，这会导致不必要的服务器错误。默认情况下，@Path变量的参数“必需”为true（因此，默认值为@PathVariable（name=“userId”，必需=true）），并且在该参数上没有@ApiParam也可以正常工作。就我而言，这些注释不应该改变彼此的行为。那是斯瓦格的错误还是只是滥用？

Answer 1

@ApiParam的参数“required”在默认情况下为false，因此您只需将其更改为true，就可以通过Swagger UI将其作为必需参数。

@ApiParam(value = "The user id", required = true) @PathVariable("userId") Integer userId