java 接口 返回值_java api返回值的标准化详解

api返回值的标准化

例如

{"status":200,"message":"操作成功","data":"{\"id\":1,\"name\":\"张三\"}"}

封装返回对象

对象被封装在base.util.ResponseUtils类型下，返回值是标准的ResponseEntity对象，返回体进行了二次封装，主要有status,messsage和data组成，返回方法有ok和okMessage，如果真是返回消息，不需要对象，可以选择使用okMessage，反之使用ok方法。

封装的返回对象：

@Builder

@Getter

@NoArgsConstructor

@AllArgsConstructor

static class ResponseBody {

private int status;

private String message;

private Object data;

}

httpError和我们封装的httpError

对于http error来说有很多种，基本可以定为code在400到500之间的，像客户端参数问题就是400- bad request,而没有认证就是401-Unauthorized,认证但没有对应的权限就是403-Forbidden,请求的

资源没有发现就是404-Not Found，请求方式错误(方法是post，你发起请求用了get)就是405- Method Not Allowed等。