在spring boot中发送响应的最佳实践

Question

我正在spring boot中编写RESTAPI-s。我想确保我的代码对于使用swagger API开发工具（swagger）的前端开发人员是可读的。例如

@GetMapping("/getOne")
    public ResponseEntity<?> getOne(@RequestParam String id) {
        try {
            return new ResponseEntity<Branch>(branchService.getOne(id), HttpStatus.OK);
        } catch (Exception e) {
            return new ResponseEntity<FindError>(new FindError(e.getMessage()), HttpStatus.BAD_REQUEST);
        }
    }

如果请求成功，响应是一个分支对象，如果失败，响应是只有一个属性（消息）的FindError对象。因此，这两种方法的执行取决于响应。但是swagger UI没有显示响应应该如何显示，因为我使用了“？”作为泛型类型。这是捕捉错误的最佳实践吗？（这种编码文档的虚张声势对前端开发人员没有用处，因为它不显示响应对象）。或者有解决上述问题的最佳实践吗？

有很多方法可以返回不同的对象，比如布兰奇。事先谢谢

Answer 1

我建议你这样做。

@GetMapping("/getOne")
public Response getOne(@RequestParam String id) {
        ResponseEntity<Branch> resbranch;
        ResponseEntity<FindError> reserror;
        try {
            resbranch=new ResponseEntity<Branch>(branchService.getOne(id), HttpStatus.OK);
            return Response.status(200).entity(resbranch).build();

        } catch (Exception e) {
            reserror=new ResponseEntity<FindError>(new FindError(e.getMessage()), HttpStatus.BAD_REQUEST);
            return Response.status(400).entity(reserror).build();
        }
    }

200表示正常，400表示错误请求。在这里，将不再有模棱两可的类型。。

Answer 2

首先，您应该遵循RESTful API的最佳实践。不要使用动词，而是使用名词作为URL.So而不是@GetMap（"/getOne"），您可以将其编写为@GetMap（"/分支/{id}"）。您可以参考此博客https://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api/

@2ndly，不要将泛型类型返回为？相反，您可以使用特定的类型，这里作为分支，并进行中央异常处理。以下代码片段可以帮助您:

@GetMapping("/branch/{id}")
public ResponseEntity<Branch> getBranch(@Pathvariable String id) {
{
    Branch branch = branchService.getOne(id);

    if(branch == null) {
         throw new RecordNotFoundException("Invalid Branch id : " + id);
    }
    return new ResponseEntity<Branch>(branch, HttpStatus.OK);
}

RecordNotFoundException.java

@ResponseStatus(HttpStatus.NOT_FOUND)
public class RecordNotFoundException extends RuntimeException
{
    public RecordNotFoundException(String exception) {
        super(exception);
    }
}

CustomExceptionHandler.java

@ControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler
{
    @ExceptionHandler(Exception.class)
    public final ResponseEntity<Object> handleAllExceptions(Exception ex, WebRequest request) {
        List<String> details = new ArrayList<>();
        details.add(ex.getLocalizedMessage());
        ErrorResponse error = new ErrorResponse("Server Error", details);
        return new ResponseEntity(error, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    @ExceptionHandler(RecordNotFoundException.class)
    public final ResponseEntity<Object> handleRecordNotFoundException(RecordNotFoundException ex, WebRequest request) {
        List<String> details = new ArrayList<>();
        details.add(ex.getLocalizedMessage());
        ErrorResponse error = new ErrorResponse("Record Not Found", details);
        return new ResponseEntity(error, HttpStatus.NOT_FOUND);
    }
}

ErrorResponse.java

public class ErrorResponse
{
    public ErrorResponse(String message, List<String> details) {
        super();
        this.message = message;
        this.details = details;
    }

    private String message;

    private List<String> details;

    //Getter and setters
}

上面的类处理多个异常，包括RecordNotFoundException，你也可以自定义有效负载验证。

测试用例：

1) HTTP GET /branch/1 [VALID]

HTTP Status : 200

{
    "id": 1,
    "name": "Branch 1",
    ...
}
2) HTTP GET /branch/23 [INVALID]

HTTP Status : 404

{
    "message": "Record Not Found",
    "details": [
        "Invalid Branch id : 23"
    ]
}