1.0.0

api-server/src/main/java/com/zq/api/constant/ApiCodeEnum.java

@@ -2,39 +2,81 @@ package com.zq.api.constant;
 
 
 /**
 /**
  * API响应码
  * API响应码
+ *
+ * @author wilmiam
+ * @since 2021-07-14 11:37
  */
  */
 public enum ApiCodeEnum {
 public enum ApiCodeEnum {
 
 
+    /**
+     * 成功
+     */
     SUCCESS("200", "成功"),
     SUCCESS("200", "成功"),
 
 
+    /**
+     * 未知错误
+     */
     UNKNOWN_ERROR("100", "未知错误"),
     UNKNOWN_ERROR("100", "未知错误"),
 
 
+    /**
+     * 登陆验证失败
+     */
     LOGIN_VALID_ERROR("101", "登陆验证失败"),
     LOGIN_VALID_ERROR("101", "登陆验证失败"),
 
 
+    /**
+     * 版本号错误
+     */
     VERSION_ERROR("102", "版本号错误"),
     VERSION_ERROR("102", "版本号错误"),
 
 
+    /**
+     * 调用方法不存在
+     */
     METHOD_ERROR("103", "调用方法不存在"),
     METHOD_ERROR("103", "调用方法不存在"),
 
 
+    /**
+     * 调用方法异常
+     */
     METHOD_HANDLER_ERROR("104", "调用方法异常"),
     METHOD_HANDLER_ERROR("104", "调用方法异常"),
 
 
+    /**
+     * 传递参数异常
+     */
     PARAM_ERROR("105", "传递参数异常"),
     PARAM_ERROR("105", "传递参数异常"),
 
 
+    /**
+     * IP黑名单拦截
+     */
     IP_BLACK("106", "IP黑名单拦截"),
     IP_BLACK("106", "IP黑名单拦截"),
 
 
+    /**
+     * API服务维护中
+     */
     SERVER_MAINTAIN("107", "API服务维护中"),
     SERVER_MAINTAIN("107", "API服务维护中"),
 
 
+    /**
+     * 签名校验失败
+     */
     CHECK_SIGN_VALID_ERROR("108", "签名校验失败"),
     CHECK_SIGN_VALID_ERROR("108", "签名校验失败"),
 
 
+    /**
+     * 服务不可用
+     */
     SERVICE_NOT_AVAILABLE("109", "服务不可用"),
     SERVICE_NOT_AVAILABLE("109", "服务不可用"),
 
 
+    /**
+     * 业务处理失败
+     */
     BUSINESS_ERROR("400", "业务处理失败"),
     BUSINESS_ERROR("400", "业务处理失败"),
 
 
+    /**
+     * 服务器繁忙
+     */
     SERVER_ERROR("500", "服务器繁忙"),
     SERVER_ERROR("500", "服务器繁忙"),
 
 
     ;
     ;
 
 
-    private String code;
-    private String msg;
+    private final String code;
+    private final String msg;
 
 
     ApiCodeEnum(String code, String msg) {
     ApiCodeEnum(String code, String msg) {
         this.code = code;
         this.code = code;