C# API统一返回

public class ApiResultHelper
{
    #region 返回值结构
    /// <summary>
    /// ajax失败
    /// </summary>
    /// <param name="msg">失败的消息</param>
    /// <returns></returns>
    public static Result renderError(string msg)
    {
        Result result = new Result();
        result.setSuccess(false);
        result.setCode(Result.FAILURE);
        result.setMsg(msg);
        return result;
    }

    /// <summary>
    /// ajax失败
    /// </summary>
    /// <param name="msg">失败的消息</param>
    ///<param name="code">失败的编码</param>
    /// <returns></returns>
    public static Result renderError(string msg, int code)
    {
        Result result = new Result();
        result.setSuccess(false);
        result.setCode(code);
        result.setMsg(msg);
        return result;
    }
    /// <summary>
    /// ajax失败
    /// </summary> 
    /// <returns></returns>
    public static Result renderError()
    {
        Result result = new Result();
        result.setSuccess(false);
        result.setCode(Result.FAILURE);
        result.setMsg(Result.STR_FAIL);
        return result;
    }

    public static Result renderError(object obj)
    {
        Result result = new Result();
        result.setSuccess(false);
        result.setCode(Result.FAILURE);
        result.setObj(obj);
        return result;
    }

    /// <summary>
    /// ajax失败,参数为空或错误
    /// </summary> 
    /// <returns></returns>
    public static Result renderErrorParamNotNull()
    {
        Result result = new Result();
        result.setSuccess(false);
        result.setCode(Result.FAILURE);
        result.setMsg(Result.STR_PARAM_NOT_NULL);
        return result;
    }

    /// <summary>
    /// ajax成功
    /// </summary> 
    /// <returns></returns>
    public static Result renderSuccess()
    {
        Result result = new Result();
        result.setSuccess(true);
        result.setMsg(Result.STR_SUCCESS);
        return result;
    }

    /// <summary>
    /// 成功
    /// </summary>
    /// <param name="msg">消息</param>
    /// <returns></returns>
    public static Result renderSuccess(string msg)
    {
        Result result = new Result();
        result.setCode(Result.SUCCESS);
        result.setSuccess(true);
        result.setMsg(msg);
        return result;
    }
    /// <summary>
    /// 成功
    /// </summary>
    /// <param name="msg">消息</param>
    /// <returns></returns>
    public static Result renderSuccess(string msg,int code,object obj)
    {
        Result result = new Result();
        result.setCode(code);
        result.setSuccess(true);
        result.setMsg(msg);
        result.setObj(obj);
        return result;
    }

    /// <summary>
    /// 成功
    /// </summary>
    /// <param name="obj">对象</param>
    /// <returns></returns>
    public static Result renderSuccess(object obj)
    {
        Result result = new Result();
        result.setCode(Result.SUCCESS);
        result.setSuccess(true);
        result.setObj(obj);
        return result;
    }

    /// <summary>
    /// 成功
    /// </summary>
    /// <param name="obj">对象</param>
    /// <param name="msg">消息</param>
    /// <returns></returns>
    public static Result renderSuccess(object obj, string msg)
    {
        Result result = new Result();
        result.setCode(Result.SUCCESS);
        result.setSuccess(true);
        result.setMsg(msg);
        result.setObj(obj);
        return result;
    }

    /// <summary>
    /// 获取分页后数据
    /// </summary>
    /// <param name="count">总数量</param>
    /// <param name="size">页大小</param>
    /// <param name="current">当前页</param>
    /// <param name="list">集合数据</param>
    /// <returns></returns>
    public static Result PageData(int count, int size, int current, object list)
    {
        Dictionary<string, object> dictionary = new Dictionary<string, object>();
        dictionary.Add("total", count);
        dictionary.Add("size", size);
        dictionary.Add("current", current);
        dictionary.Add("records", list);
        return renderSuccess(dictionary);
    }
    #endregion
}
public class Result
{
    public static int SUCCESS = 1;
    public static int FAILURE = -1;
    public static int OTHER = 2;      //其他,页面显示
    public static int FAILURE_AUTHC = -9999;

    public static String STR_PARAM_NOT_NULL = "Incoming parameter cannot be empty";
    public static String STR_SUCCESS = "Operation succeeded";
    public static String STR_FAIL = "operation failed";


    /**
     * 请求是否错误,默认false
     */
    public Boolean success { get; set; }
    /**
     * 请求返回code
     */
    public int code { get; set; }
    /**
     * 请求返回描述
     */
    public String msg { get; set; }

    public Object obj { get; set; }

    public Result() { }

    public Result(int code, String msg)
    {
        this.code = code;
        this.msg = msg;
    }
    public Result(int code, String msg, Boolean success)
    {
        this.code = code;
        this.msg = msg;
        this.success = success;
    }

    public Boolean isSuccess()
    {
        return success;
    }

    public void setSuccess(Boolean success)
    {
        this.success = success;
    }

    public String getMsg()
    {
        return msg;
    }

    public void setMsg(String msg)
    {
        this.msg = msg;
    }

    public Object getObj()
    {
        return obj;
    }

    public void setObj(Object obj)
    {
        this.obj = obj;
    }

    public int getCode()
    {
        return code;
    }

    public void setCode(int code)
    {
        this.code = code;
    }
}

调用:

 /// <summary>
 /// **
 /// </summary>
 /// <returns></returns>
 [Route("regions")]
 [HttpGet]
 public async Task<ActionResult<Result>> Get**()
 {
     try
     {
         **
         return ApiResultHelper.renderSuccess(**);
     }
     catch (Exception e)
     {

         return ApiResultHelper.renderError(e);
     }
 }

  • 2
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值