添加接口文档

src/main/java/com/usky/dxtop/common/core/domain/ApiResult.java

@@ -0,0 +1,97 @@
+package com.usky.dxtop.common.core.domain;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+
+import java.beans.Transient;
+import java.io.Serializable;
+
+
+/**
+ * <p>Api 调用结果统一包装类</p>
+ *
+ * @param <T>
+ * @author chenpeng
+ * Create time 2018年11月30日 下午5:17:42
+ */
+@Data
+@ApiModel(description = "API 响应结果")
+public class ApiResult<T> implements Serializable {
+
+    private static final long serialVersionUID = 5247512550376272642L;
+
+    private static final String SUCCESS_CODE = "0";
+
+    @ApiModelProperty(value = "状态", required = true)
+    private ResultStatus status;
+
+    @ApiModelProperty(value = "状态码", required = true)
+    private String code;
+
+    @ApiModelProperty(value = "消息")
+    private String msg;
+
+    @ApiModelProperty(value = "内容")
+    private T data;
+
+    @ApiModelProperty(value = "异常类")
+    private String exception;
+
+    public ApiResult() {
+    }
+
+    public ApiResult(T content) {
+        this.status = ResultStatus.SUCCESS;
+        this.code = SUCCESS_CODE;
+        this.data = content;
+    }
+
+    public ApiResult(String code, String message) {
+        this.status = ResultStatus.ERROR;
+        this.code = code;
+        this.msg = message;
+    }
+
+    public static <T> ApiResult<T> success(T content) {
+        return new ApiResult<>(content);
+    }
+
+    public static ApiResult<Void> success() {
+        return new ApiResult<>(null);
+    }
+
+    public static <T> ApiResult<T> error(String code, String message) {
+        return new ApiResult<>(code, message);
+    }
+
+    public static <T> ApiResult<T> error(String code, String exception, String message) {
+        ApiResult<T> apiResult = new ApiResult<>(code, message);
+        apiResult.setException(exception);
+        return apiResult;
+    }
+
+    @Transient
+    public boolean isSuccess() {
+        return ResultStatus.SUCCESS == status;
+    }
+
+    @Transient
+    public boolean isError() {
+        return !isSuccess();
+    }
+
+    /**
+     * 业务响应状态
+     */
+    public enum ResultStatus {
+        /**
+         * 返回状态：成功
+         */
+        SUCCESS,
+        /**
+         * 返回状态：失败
+         */
+        ERROR
+    }
+}