-
Notifications
You must be signed in to change notification settings - Fork 1
/
BaseApiController.cs
288 lines (273 loc) · 11.2 KB
/
BaseApiController.cs
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
using EasyWeb.Core.Models;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.ModelBinding;
namespace EasyWeb.AspNetCore.Controllers
{
/// <summary>
/// A base class for an MVC controller without view support.
/// </summary>
[ApiController]
public abstract class BaseApiController : ControllerBase
{
private const string BadRequestMessage = "An error occurred while executing the operation.";
/// <summary>
/// Creates an Microsoft.AspNetCore.Mvc.BadRequestObjectResult that produces a Microsoft.AspNetCore.Http.StatusCodes.Status400BadRequest
/// response.
/// </summary>
/// <param name="modelState">
/// The Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary containing errors
/// to be returned to the client.
/// </param>
/// <returns>
/// The created Microsoft.AspNetCore.Mvc.BadRequestObjectResult for the response.
/// See <see cref="BadRequestResult"/>
/// </returns>
public override BadRequestObjectResult BadRequest(ModelStateDictionary modelState)
{
return BadRequest(modelState, false);
}
/// <summary>
/// Creates an Microsoft.AspNetCore.Mvc.BadRequestObjectResult that produces a Microsoft.AspNetCore.Http.StatusCodes.Status400BadRequest
/// response.
/// </summary>
/// <param name="modelState">
/// /// The Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary containing errors
/// to be returned to the client.
/// </param>
/// <param name="isUserFriendlyMessage">
/// Indicates if <see>
/// <cref>Message</cref>
/// </see>
/// comes from resources and readable by directly users or not.
/// </param>
/// <returns>
/// The created Microsoft.AspNetCore.Mvc.BadRequestObjectResult for the response.
/// See <see cref="BadRequestResult"/>
/// </returns>
[NonAction]
protected virtual BadRequestObjectResult BadRequest(ModelStateDictionary modelState, bool isUserFriendlyMessage)
{
var mainErrors = modelState.Where(x => !string.IsNullOrEmpty(x.Key))
.ToDictionary(k => k.Key, v => v.Value.Errors.Select(x => x.ErrorMessage));
return base.BadRequest(new ApiResult
{
Success = false,
Data = mainErrors,
Key = "ModelState",
Message = string.Join("\n", mainErrors.SelectMany(x => x.Value)),
IsUserFriendlyMessage = isUserFriendlyMessage
});
}
/// <summary>
/// Creates an Microsoft.AspNetCore.Mvc.BadRequestObjectResult that produces a Microsoft.AspNetCore.Http.StatusCodes.Status400BadRequest
/// response.
/// </summary>
/// <param name="error">
/// An error object to be returned to the client.
/// </param>
/// <returns>
/// The created Microsoft.AspNetCore.Mvc.BadRequestObjectResult for the response.
/// See <see cref="BadRequestResult"/>
/// </returns>
public override BadRequestObjectResult BadRequest(object error)
{
return base.BadRequest(new ApiResult
{
Success = false,
Data = error,
Key = "BadRequest",
Message = BadRequestMessage
});
}
/// <summary>
/// Creates an Microsoft.AspNetCore.Mvc.BadRequestObjectResult that produces a Microsoft.AspNetCore.Http.StatusCodes.Status400BadRequest
/// response.
/// </summary>
/// <param name="error">
/// An error object to be returned to the client.
/// </param>
/// <param name="key">
/// Key of message or request type.
/// </param>
/// <returns>
/// The created Microsoft.AspNetCore.Mvc.BadRequestObjectResult for the response.
/// See <see cref="BadRequestResult"/>
/// </returns>
[NonAction]
protected virtual BadRequestObjectResult BadRequest(object error, string key)
{
return base.BadRequest(new ApiResult
{
Success = false,
Data = error,
Key = key,
Message = BadRequestMessage
});
}
/// <summary>
/// Creates an Microsoft.AspNetCore.Mvc.BadRequestObjectResult that produces a Microsoft.AspNetCore.Http.StatusCodes.Status400BadRequest
/// response.
/// </summary>
/// <param name="error">
/// An error object to be returned to the client.
/// </param>
/// <param name="key">
/// Key of message or request type.
/// </param>
/// <param name="message">
/// Message about request. Some unsuccessful requests have message about it.
/// </param>
/// <returns>
/// The created Microsoft.AspNetCore.Mvc.BadRequestObjectResult for the response.
/// See <see cref="BadRequestResult"/>
/// </returns>
[NonAction]
protected virtual BadRequestObjectResult BadRequest(object error, string key, string message)
{
return base.BadRequest(new ApiResult
{
Success = false,
Data = error,
Key = key,
Message = message,
IsUserFriendlyMessage = true
});
}
/// <summary>
/// Creates an <see cref="NotFoundObjectResult"/> that produces a <see cref="StatusCodes.Status404NotFound"/> response.
/// </summary>
/// <returns>The created <see cref="NotFoundObjectResult"/> for the response.</returns>
[NonAction]
public override NotFoundObjectResult NotFound(object value)
{
return base.NotFound(new ApiResult
{
Success = false,
Key = "NotFound",
Data = value
});
return base.NotFound(value);
}
/// <summary>
/// Creates a <see cref="AcceptedResult"/> object that produces an <see cref="StatusCodes.Status202Accepted"/> response.
/// </summary>
/// <param name="value">The optional content value to format in the entity body; may be null.</param>
/// <returns>The created <see cref="AcceptedResult"/> for the response.</returns>
[NonAction]
public override AcceptedResult Accepted(object value)
{
return base.Accepted(new ApiResult
{
Success = true,
Key = "Accepted",
Data = value
});
return base.Accepted(value);
}
/// <summary>
/// Creates a <see cref="AcceptedResult"/> object that produces an <see cref="StatusCodes.Status202Accepted"/> response.
/// </summary>
/// <param name="uri">The URI with the location at which the status of requested content can be monitored.</param>
/// <param name="value">The optional content value to format in the entity body; may be null.</param>
/// <returns>The created <see cref="AcceptedResult"/> for the response.</returns>
[NonAction]
public override AcceptedResult Accepted(Uri uri, object value)
{
return base.Accepted(uri, new ApiResult
{
Success = true,
Key = "Accepted",
Data = value
});
}
/// <summary>
/// Creates a <see cref="AcceptedResult"/> object that produces an <see cref="StatusCodes.Status202Accepted"/> response.
/// </summary>
/// <param name="uri">The URI with the location at which the status of requested content can be monitored.</param>
/// <param name="value">The optional content value to format in the entity body; may be null.</param>
/// <returns>The created <see cref="AcceptedResult"/> for the response.</returns>
[NonAction]
public override AcceptedResult Accepted(string uri, object value)
{
return base.Accepted(uri, new ApiResult
{
Success = true,
Key = "Accepted",
Data = value
});
}
/// <summary>
/// Creates a <see cref="CreatedResult"/> object that produces a <see cref="StatusCodes.Status201Created"/> response.
/// </summary>
/// <param name="uri">The URI at which the content has been created.</param>
/// <param name="value">The content value to format in the entity body.</param>
/// <returns>The created <see cref="CreatedResult"/> for the response.</returns>
[NonAction]
public override CreatedResult Created(Uri uri, object value)
{
return base.Created(uri, new ApiResult
{
Success = true,
Data = value,
Key = "Created"
});
}
/// <summary>
/// Creates a <see cref="CreatedResult"/> object that produces a <see cref="StatusCodes.Status201Created"/> response.
/// </summary>
/// <param name="uri">The URI at which the content has been created.</param>
/// <param name="value">The content value to format in the entity body.</param>
/// <returns>The created <see cref="CreatedResult"/> for the response.</returns>
[NonAction]
public override CreatedResult Created(string uri, object value)
{
return base.Created(uri, new ApiResult
{
Success = true,
Key = "Created",
Data = value
});
}
/// <summary>
/// Creates an <see cref="OkObjectResult"/> object that produces an <see cref="StatusCodes.Status200OK"/> response.
/// </summary>
/// <param name="value">The content value to format in the entity body.</param>
/// <returns>The created <see cref="OkObjectResult"/> for the response.</returns>
[NonAction]
public override OkObjectResult Ok(object value)
{
if (value == null)
return base.Ok(new ApiResult
{
Success = true,
Data = new object(),
Message = "Data is empty",
Key = "OK"
});
return base.Ok(new ApiResult
{
Success = true,
Data = value,
Key = "OK"
});
}
/// <summary>
/// Creates an <see cref="OkObjectResult"/> object that produces an <see cref="StatusCodes.Status200OK"/> response.
/// </summary>
/// <param name="value">The content value to format in the entity body.</param>
/// <param name="meta">The content value to format in the entity meta.</param>
/// <returns>The created <see cref="OkObjectResult"/> for the response.</returns>
[NonAction]
protected virtual OkObjectResult Ok(object value, object meta)
{
return base.Ok(new ApiResult
{
Success = true,
Data = value,
Meta = meta,
Key = "OK"
});
}
}
}