NetCore 统一输出格式

配置 API:示例源码下载

builder.Services.AddControllers();

app.MapControllers();

 错误代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public enum ResponseCode
{
    [Description("操作失败")]
    BadRequest = 1001,
 
    [Description("操作成功")]
    OK = HttpStatusCode.OK,
    [Description("没有权限")]
    Unauthorized = HttpStatusCode.Unauthorized,
    [Description("未找到服务")]
    NotFound = HttpStatusCode.NotFound,
    [Description("服务器理解请求客户端的请求,但是拒绝执行此请求")]
    Forbidden = HttpStatusCode.Forbidden,
    [Description("服务器内部错误,无法完成请求")]
    InternalServerError = HttpStatusCode.InternalServerError,
    [Description("请求错误")]
    BadGateway = HttpStatusCode.BadGateway
}

 

 统一输出格式:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
public class BaseResponse
{
    /// <summary>
    /// 返回码
    /// </summary>
    public ResponseCode ErrorCode { set; get; }
 
    /// <summary>
    /// 是否成功
    /// </summary>
    public bool IsSuccess { get; set; } = true;
 
    /// <summary>
    /// 返回消息
    /// </summary>
    public string Message { get; set; } = "";
    public object Data { get; internal set; }
 
    /// <summary>
    /// 操作成功
    /// </summary>
    public static BaseResponse Success(string message = "操作成功")
    {
        return new BaseResponse { Message = "操作成功!", ErrorCode = ResponseCode.OK };
    }
 
    /// <summary>
    /// 操作失败
    /// </summary>
    public static BaseResponse Fail(string message = "操作失败!")
    {
        return new BaseResponse { Message = message, ErrorCode = ResponseCode.BadRequest };
    }
 
    /// <summary>
    /// 操作失败
    /// </summary>
    public static BaseResponse Fail(string message, ResponseCode code = ResponseCode.BadRequest)
    {
        return new BaseResponse { Message = message, ErrorCode = code };
    }
 
    /// <summary>
    /// 错误异常
    /// </summary>
    public static BaseResponse Error(string message = "错误异常")
    {
        return new BaseResponse { Message = message, ErrorCode = ResponseCode.InternalServerError };
    }
 
    /// <summary>
    /// 错误异常
    /// </summary>
    public static BaseResponse Error(string message, ResponseCode ErrorCode = ResponseCode.InternalServerError)
    {
        return new BaseResponse { Message = message, ErrorCode = ErrorCode };
    }
}
 
public class BaseResponse<T> : BaseResponse where T : class
{
    /// <summary>
    /// 返回实体
    /// </summary>
    public T Data { get; set; }
 
    /// <summary>
    /// 操作成功
    /// </summary>
    public static BaseResponse Success(T data, string message = "操作成功")
    {
 
        return new BaseResponse { Message = "操作成功!", Data = data, ErrorCode = ResponseCode.OK };
    }
}
 
public class PageResponse<T> : BaseResponse where T : class
{
    /// <summary>
    /// 总记录条数
    /// </summary>
    public int Total { get; set; }
 
    /// <summary>
    /// 响应数据
    /// </summary>
    public List<T> Data { get; set; }
}
posted @   microsoft-zhcn  阅读(25)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· DeepSeek 开源周回顾「GitHub 热点速览」
· 物流快递公司核心技术能力-地址解析分单基础技术分享
· .NET 10首个预览版发布:重大改进与新特性概览!
· AI与.NET技术实操系列(二):开始使用ML.NET
· 单线程的Redis速度为什么快?
点击右上角即可分享
微信分享提示