Swagger @ApiResponses 注解用于在 Swagger UI 中显示一个或多个自定义响应消息,以替代默认的响应消息。
作用:
用于自定义响应消息,能够提供更加友好的响应信息。
可以指定多个 @ApiResponse 注解,每个注解代表一个响应消息。
示例:
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success"),
@ApiResponse(code = 400, message = "Invalid Request"),
@ApiResponse(code = 401, message = "Unauthorized"),
@ApiResponse(code = 500, message = "Internal Server Error")
})
@RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)
public ResponseEntity<String> deleteUser(@PathVariable("id") long id) {
// ...
}
上面的示例中,定义了四个响应消息,分别对应 HTTP 响应码 200、400、401、500。如果用户使用 Swagger UI 查看这个 API 的文档时,将会看到这些自定义的响应消息。