Bläddra i källkod

后端接口响应格式

master
qdjjx 4 år sedan
förälder
incheckning
150fdcdc3a

+ 81
- 0
专题/后端/2020.12.1后端接口格式.md Visa fil

@@ -0,0 +1,81 @@
1
+> 正常响应
2
+
3
+```
4
+{
5
+    "version": "1.0.0.0",
6
+    "code": 200,
7
+    "message": "this is message",
8
+    "isError": false,
9
+    "data": {
10
+        "id": 1,
11
+        "name": "name",
12
+        "age": 21
13
+    }
14
+}
15
+```
16
+
17
+> 异常响应
18
+
19
+```
20
+{
21
+    "version": "1.0.0.0",
22
+    "code": 500,
23
+    "isError": true,
24
+    "responseException": {
25
+        "exceptionMessage": "Unhandled Exception occurred. Unable to process the request."
26
+    }
27
+}
28
+```
29
+
30
+> 入参字段不符合要求响应
31
+
32
+```
33
+{
34
+    "version": "1.0.0.0",
35
+    "code": 400,
36
+    "isError": true,
37
+    "responseException": {
38
+        "exceptionMessage": "Request responded with one or more validation errors occurred.",
39
+        "validationErrors": [
40
+            {
41
+                "name": "Name",
42
+                "reason": "最大长度5"
43
+            },
44
+            {
45
+                "name": "Location",
46
+                "reason": "最大长度5"
47
+            }
48
+        ]
49
+    }
50
+}
51
+```
52
+
53
+# code状态码一栏表
54
+
55
+状态码类型:
56
+
57
+- 1**:服务器收到,客户端继续操作
58
+- 2**:服务端处理成功
59
+- 3**:服务端重定向
60
+- 4**:客户端错误
61
+- 5**:服务端错误
62
+
63
+状态码:
64
+
65
+- 200:服务端确认客户端请求成功,一般用于GET和POST请求
66
+- 201:服务端创建资源成功
67
+- 204:服务端没有内容返回
68
+- 404:客户端要找的资源不存在
69
+- 412:客户端先决条件错误
70
+- 413:客户端请求实体过大
71
+- 414:客户端请求URL过长
72
+- 415:客户端媒体格式不对
73
+- 419:客户端身份验证超时
74
+- 422:客户端实体验证失败
75
+- 429:客户端请求过多
76
+- 431:客户端请求头过大
77
+- 500:服务端内部错误
78
+- 501:服务端不支持的请求
79
+- 502:服务端收到来自远端的无效响应
80
+- 503:服务端无法处理客户端请求
81
+- 505:服务端不支持请求的HTTP协议版本

+ 119
- 0
专题/后端/2020.12.1后端接口格式实现.md Visa fil

@@ -0,0 +1,119 @@
1
+> 正常响应
2
+
3
+```
4
+{
5
+    "version": "1.0.0.0",
6
+    "code": 200,
7
+    "message": "this is message",
8
+    "isError": false,
9
+    "data": {
10
+        "id": 1,
11
+        "name": "name",
12
+        "age": 21
13
+    }
14
+}
15
+
16
+================================
17
+
18
+使用ApiResponse构造函数返回正常响应。
19
+
20
+[Route("get1")]
21
+[HttpGet]
22
+public ApiResponse Get1()
23
+{
24
+
25
+    var data = new { Id = 1, Name = "name", Age = 21 };
26
+    return new ApiResponse("this is message", data, StatusCodes.Status200OK);
27
+
28
+}
29
+```
30
+
31
+> 异常响应
32
+
33
+```
34
+{
35
+    "version": "1.0.0.0",
36
+    "code": 500,
37
+    "isError": true,
38
+    "responseException": {
39
+        "exceptionMessage": "Unhandled Exception occurred. Unable to process the request."
40
+    }
41
+}
42
+
43
+================================
44
+
45
+在接口层throw抛出异常
46
+
47
+[Route("get1")]
48
+[HttpGet]
49
+public ApiResponse Get1()
50
+{
51
+    try
52
+    {
53
+
54
+        int i = 0;
55
+        int j = 5 / i;
56
+        return new ApiResponse("New record has been created in the database", 1, StatusCodes.Status201Created);
57
+    }
58
+    catch (Exception ex)
59
+    {
60
+
61
+        throw;
62
+    }
63
+
64
+}
65
+
66
+==============================
67
+
68
+使用ApiException抛出特定类型的异常。
69
+
70
+[HttpGet]
71
+[Route("get2")]
72
+public ApiResponse Get2()
73
+{
74
+    throw new ApiException("doesnt exist", StatusCodes.Status404NotFound);
75
+}
76
+```
77
+
78
+> 入参字段不符合要求响应
79
+
80
+```
81
+{
82
+    "version": "1.0.0.0",
83
+    "code": 400,
84
+    "isError": true,
85
+    "responseException": {
86
+        "exceptionMessage": "Request responded with one or more validation errors occurred.",
87
+        "validationErrors": [
88
+            {
89
+                "name": "Name",
90
+                "reason": "最大长度5"
91
+            },
92
+            {
93
+                "name": "Location",
94
+                "reason": "最大长度5"
95
+            }
96
+        ]
97
+    }
98
+}
99
+
100
+================================
101
+
102
+使用ApiException抛模型错误异常。
103
+
104
+[HttpPost]
105
+[Route("customException")]
106
+public ApiResponse Post1(AutoWrapperDemo model)
107
+{
108
+    if(!ModelState.IsValid)
109
+    {
110
+        throw new ApiException(ModelState.AllErrors());
111
+    }
112
+    return new ApiResponse("New record has been created in the database", 1, StatusCodes.Status201Created);
113
+}
114
+
115
+
116
+```
117
+
118
+
119
+

团队/2020.11.26大家来说.md → 团队/2020.11.26迎合取悦与信息量.md Visa fil

@@ -1,4 +1,13 @@
1
-# 为什么
1
+
2
+# 迎合取悦与信息量
3
+
4
+一个真实的故事。
5
+
6
+# 流程和流程的弹性
7
+
8
+沟通的点和频率。
9
+
10
+# 问题域和解决域
2 11
 
3 12
 某种程度上,我们的日常工作就是解决问题的过程。而我们发现,什么是需要解决的问题,以及解决问题的方式方法因人而异,并且没有绝对正确答案。
4 13
 

Laddar…
Avbryt
Spara