java - 如何在 Swagger 中更改成功操作的响应状态代码？

Question

如图所示，它为添加操作显示“响应类(状态 200)”。但是，添加操作已以永远不会返回 200 的方式实现。成功时返回 201。

我的问题是如何将 (Status 200) 更改为 (Status 201)？该部分代码如下:

@RequestMapping(method = RequestMethod.PUT, value = "/add")
@ApiOperation(value = "Creates a new person", code = 201)
@ApiResponses(value = {
        @ApiResponse(code = 201, message = "Record created successfully"),
        @ApiResponse(code = 409, message = "ID already taken")
})
public ResponseEntity<String> add(@RequestParam(value = "name", required = true) String name,
        @RequestParam(value = "id", required = true) String id) {
    if (PD.searchByID(id).size() == 0) {
        Person p = new Person(name, id);
        PD.addPerson(p);
        System.out.println("Person added.");
        return new ResponseEntity<String>(HttpStatus.CREATED);
    } else {
        System.out.println("ID already taken.");
        return new ResponseEntity<String>(HttpStatus.CONFLICT);
    }
}

谢谢!

Answer 1

您可以将 @ResponseStatus 注释添加到任何 Controller 方法来定义它应该返回的 http 状态。例如

在 Controller 方法上添加以下注释:

@ResponseStatus(code = HttpStatus.CREATED)

将返回 HTTP 状态 201(已创建)