AppointmentOA/api_v1/Appointment.Entity/Utility/ApiResult.cs

using System;
using System.Collections.Generic;
using System.Net;
using System.Text;

namespace Appointment.Entity
{
    /// <summary>
    /// 接口返回数据标准
    /// </summary>
    public class ApiResult
    {
        /// <summary>
        /// 响应状态:true-成功执行,flase-响应异常
        /// </summary>
        public bool IsSuccess { get { return this.Code == (int)HttpStatusCode.OK; } }

        /// <summary>
        /// 是否有效执行以IsSuccess为基准
        /// 200-有效执行,500-服务错误
        /// </summary>
        /// <remarks>
        /// 此属性为定制化返回代码,例如登录成功并需要返回提示修改密码等相关类似的业务
        /// </remarks>
        public int Code { get; set; }

        /// <summary>
        /// 返回消息文本内容
        /// </summary>
        public string Msg { get; set; }

        /// <summary>
        /// 返回数据
        /// </summary>
        public object Info { get; set; }

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="code"></param>
        /// <param name="msg"></param>
        /// <param name="info"></param>
        public ApiResult(int code = (int)HttpStatusCode.OK, string msg = "操作成功", object info = null)
        {
            this.Code = code;
            this.Msg = msg;
            this.Info = info;
        }

        /// <summary>
        /// 成功执行
        /// </summary>
        /// <param name="msg"></param>
        /// <param name="info"></param>
        /// <returns></returns>
        public static ApiResult Success(string msg = "操作成功", object info = null)
        {
            return new ApiResult
            {
                Code = (int)HttpStatusCode.OK,
                Msg = msg,
                Info = info,
            };
        }

        /// <summary>
        /// 执行错误
        /// </summary>
        /// <param name="msg"></param>
        /// <param name="code"></param>
        /// <param name="info"></param>
        /// <returns></returns>
        public static ApiResult Failed(string msg = "操作失败", object info = null, int code = (int)HttpStatusCode.InternalServerError)
        {
            return new ApiResult
            {
                Code = code,
                Msg = msg,
                Info = info,
            };
        }
    }

    /// <summary>
    /// 接口返回数据标准
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public class ApiResult<T>
    {
        /// <summary>
        /// 响应状态:true-成功执行,flase-响应异常
        /// </summary>
        public bool IsSuccess { get { return this.Code == (int)HttpStatusCode.OK; } }

        /// <summary>
        /// 是否有效执行以IsSuccess为基准
        /// 200-有效执行,500-服务错误
        /// </summary>
        /// <remarks>
        /// 此属性为定制化返回代码,例如登录成功并需要返回提示修改密码等相关类似的业务
        /// </remarks>
        public int Code { get; set; }

        /// <summary>
        /// 返回消息文本内容
        /// </summary>
        public string Msg { get; set; }

        /// <summary>
        /// 返回数据
        /// </summary>
        public T Info { get; set; }

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="code"></param>
        /// <param name="msg"></param>
        /// <param name="info"></param>
        public ApiResult(int code = (int)HttpStatusCode.OK, string msg = "操作成功", T info = default)
        {
            this.Code = code;
            this.Msg = msg;
            this.Info = info;
        }

        /// <summary>
        /// 执行成功
        /// </summary>
        /// <param name="msg"></param>
        /// <param name="info"></param>
        /// <returns></returns>
        public static ApiResult<T> Success(string msg = "操作成功", T info = default)
        {
            return new ApiResult<T>
            {
                Code = (int)HttpStatusCode.OK,
                Msg = msg,
                Info = info,
            };
        }

        /// <summary>
        /// 出现错误
        /// </summary>
        /// <param name="msg"></param>
        /// <param name="code"></param>
        /// <param name="info"></param>
        /// <returns></returns>
        public static ApiResult<T> Failed(string msg = "操作失败", int code = (int)HttpStatusCode.InternalServerError, T info = default)
        {
            return new ApiResult<T>
            {
                Code = code,
                Msg = msg,
                Info = info,
            };
        }
    }

    /// <summary>
    /// 公共Msg
    /// </summary>
    public class ApiResultMsg
    {
        /// <summary>
        /// 参数无效
        /// </summary>
        public string InvalidParameter { get { return $"参数[{_InvalidParameter}]无效！"; } set { _InvalidParameter = value; } }
        private string _InvalidParameter;

        /// <summary>
        /// 缺少参数
        /// </summary>
        public static string NoParameter { get { return "缺少参数！"; } }

        /// <summary>
        /// 没有权限
        /// </summary>
        public static string NoPower { get { return "没有权限，操作失败！"; } }

        /// <summary>
        /// 没有数据
        /// </summary>
        public static string NoData { get { return "没有数据！"; } }

        /// <summary>
        /// 数据不正确
        /// </summary>
        public static string ErrorData { get { return "数据不正确！"; } }
    }
}