房产中介管理软件第3课：统一接口返回字段

　　项目前后端分离，采用json传输数据。

　　接口返回大同小异，所以要进行返回字段一致性设置。

1、接口返回字段解释

　　code：0无措，其他有错

　　msg：提示信息

　　count：如果是列表页，返回数据总数，用于页面分页

　　data：obj类型，可以是string、list、model，用于数据

2、相关文件代码

API返回状态ApiState.cs文件

namespace Randy.Fang.Model
{
    /// <summary>
    ///  描述: API返回状态
    /// </summary>
    public class ApiState
    {
        /// <summary>
        /// 构造函数
        /// </summary>
        public ApiState() { }

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="intCode"></param>
        /// <param name="strMessage"></param>
        public ApiState(int intCode, string strMsg) { 
            this.code = intCode; 
            this.msg = strMsg; 
        }

        /// <summary>
        /// 返回代码
        /// </summary>
        public int code { set; get; }

        /// <summary>
        /// 返回内容
        /// </summary>
        public string msg { set; get; }
    }
}

API返回结果文件ApiResult.cs

namespace Randy.Fang.Model
{
    /// <summary>
    ///  描述: API返回结果
    /// </summary>
    public class ApiResult : ApiState
    {
        /// <summary>
        /// 构造函数
        /// </summary>
        public ApiResult()
        {
            this.code = ApiConstant.SUCCESS_CODE;
            this.msg = "成功";
        }

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="data"></param>
        public ApiResult(object data)
        {
            this.data = data;
            this.code = ApiConstant.SUCCESS_CODE;
            this.msg = "成功";
        }

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="intCode"></param>
        /// <param name="strMsg"></param>
        public ApiResult(int intCode, string strMsg)
        {
            this.code = intCode;
            this.msg = strMsg;
        }

        /// <summary>
        /// 数据对象
        /// </summary>          
        public object data { get; set; }

        /// <summary>
        /// 记录总数
        /// </summary>
        public long count { get; set; }
    }
}

ApiConstant.cs文件

namespace Randy.Fang.Model
{
    /// <summary>
    /// 常用类
    /// </summary>
    public class ApiConstant
    {
        /// <summary>
        /// 提示代码
        /// </summary>
        public const int INFO_CODE = 4001;

        /// <summary>
        /// 未登录代码
        /// </summary>
        public const int NO_LOGIN_CODE = 1001;

        /// <summary>
        /// 未登录代码
        /// </summary>
        public const string NO_LOGIN_TEXT = "您已经登录会话过期，需要重新登录";

        /// <summary>
        /// 成功代码
        /// </summary>
        public const int SUCCESS_CODE = 0;

        /// <summary>
        /// 成功消息
        /// </summary>
        public const string SUCCESS_TEXT = "成功";

        /// <summary>
        /// 查询错误
        /// </summary>
        public const int QUERY_ERROR_CODE = 5001;

        /// <summary>
        /// 查询错误
        /// </summary>
        public const string QUERY_ERROR_TEXT = "查询错误";

        /// <summary>
        /// 保存错误
        /// </summary>
        public const int SAVE_ERROR_CODE = 5002;

        /// <summary>
        /// 保存错误
        /// </summary>
        public const string SAVE_ERROR_TEXT = "保存错误";

        /// <summary>
        /// 删除错误
        /// </summary>
        public const int DELETE_ERROR_CODE = 5003;

        /// <summary>
        /// 删除错误
        /// </summary>
        public const string DELETE_ERROR_TEXT = "删除错误";
    }
}

3、最终参数调用的返回结果如下

（本文完）