如何在调用Rest Endpoint时在Swagger中输入参数选项

Question

我已经讨论过了:如何使用swagger定义path中的可选参数。

我有这个endpoint：

@ApiOperation(value = "Retrieve Student Data By firstName Or lastName Or middleName",nickname = "Find Student Data")
@ApiResponses(value = { @ApiResponse(code = 200, message = "Successfully Retrieved Student Data"),
        @ApiResponse(code = 404, message = "No data found !!!") })
@GetMapping(path = "/firstName/{firstName}/lastName/{lastName}/middleName/{middleName}")
public GetStudentDataResponse getStudentData(@PathVariable(required = false) String firstName, @PathVariable(required = false) String lastName,@PathVariable(required = false) String middleName) {
    return service.getStudentData(firstName,lastName,middleName);
}

当我点击restendpoint并仅传递firstName时，Swagger正在抱怨必需的参数。我们怎样才能禁用它？

注意:我真的不想创建另一个endpoint，只是为了让它通过swagger工作。

Answer 1

您需要使用@RequestParam而不是@PathVariable。然后，它允许您使参数可选。