WebApi服务接口返回值做一个简单的封装

有时候我们需要个封装类作为API接口返回的值,以便和客户端开发人员更好的沟通。接口返回的格式确定,客户端拿到返回值去解析即可。

下面是一个简单的示例:

有了这个类后,我们就可以使用了,示例如下图:

    public class ApiResultModel
    {
        /// <summary>
        /// 代码
        /// </summary>
        public ClientCode Code { get; set; }

        /// <summary>
        /// 数据
        /// </summary>
        public DataResult Data { get; set; }
        /// <summary>
        /// 错误信息
        /// </summary>
        public string ErrorMessage { get; set; }
    }

    /// <summary>
    /// 客户端代码
    /// </summary>
    public enum ClientCode
    {
        /// <summary>
        /// 未找到
        /// </summary>
        FindNull = 0,
        /// <summary>
        /// 成功
        /// </summary>
        Succeed = 1,
        /// <summary>
        /// 失败
        /// </summary>
        Fail = 2,
        /// <summary>
        /// 异常
        /// </summary>
        Exception = 3

    }

    /// <summary>
    /// 数据
    /// </summary>
    public class DataResult
    {
        /// <summary>
        /// 总数
        /// </summary>
        public int total;
        /// <summary>
        /// 行数据集
        /// </summary>
        public dynamic records;

    }
View Code

第一次写,给自己留个脚印!

posted @ 2017-03-03 11:54  寒江雪雁  阅读(238)  评论(0)    收藏  举报