当前位置:   article > 正文

Restful API返回统一响应体_rest api接口统一响应接口实体

rest api接口统一响应接口实体







参考文档:
https://github.com/kuitos/kuitos.github.io/issues/9

对于客户端开发或者网站开发而言,调用接口返回有统一的响应体,可以针对性的设计界面,代码结构更加清晰,层次也更加分明。

所以需要调用api时,要求返回结构的数据实体。以下就分享以下我的实现方法;

1、建立统一数据结构类
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class ResponseResult<T> {

	private boolean success;
	private String message;
	private T data;
	private String errorcode;
	public boolean isSuccess() {
		return success;
	}
	public void setSuccess(boolean success) {
		this.success = success;
	}
	public String getMessage() {
		return message;
	}
	public void setMessage(String message) {
		this.message = message;
	}
	public T getData() {
		return data;
	}
	public void setData(T data) {
		this.data = data;
	}
	public String getErrorcode() {
		return errorcode;
	}
	public void setErrorcode(String errorcode) {
		this.errorcode = errorcode;
	}
	public ResponseResult() {
    }
}
2、建立结果返回静态方法
public class RestResultGenerator {

	public static <T> ResponseResult<T> genResult(T data,String message){
		
		
		ResponseResult<T> result = new ResponseResult<T>();
		result.setData(data);
		result.setSuccess(true);
		result.setMessage(message);
		return result;
	}
}
3、在Controller层所有的接口返回都可以定义成 ResponseResult,而在Service层做逻辑处理,根据特定的业务来返回特定的结果;



声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/笔触狂放9/article/detail/869848
推荐阅读
相关标签
  

闽ICP备14008679号