diff options
| author | crupest <crupest@outlook.com> | 2020-08-21 21:25:33 +0800 |
|---|---|---|
| committer | crupest <crupest@outlook.com> | 2020-08-21 21:25:33 +0800 |
| commit | 53888df71f7580bf169dfab3d13d313cf96d26df (patch) | |
| tree | 6317f1debad6d58ddad04f8767f447e5ae34556d /Timeline/Swagger | |
| parent | 6fa82cabf2eebec572d23ff49a650e04128d2514 (diff) | |
| download | timeline-53888df71f7580bf169dfab3d13d313cf96d26df.tar.gz timeline-53888df71f7580bf169dfab3d13d313cf96d26df.tar.bz2 timeline-53888df71f7580bf169dfab3d13d313cf96d26df.zip | |
...
Diffstat (limited to 'Timeline/Swagger')
| -rw-r--r-- | Timeline/Swagger/ApiConvention.cs | 15 | ||||
| -rw-r--r-- | Timeline/Swagger/DefaultDescriptionOperationProcessor.cs | 39 |
2 files changed, 54 insertions, 0 deletions
diff --git a/Timeline/Swagger/ApiConvention.cs b/Timeline/Swagger/ApiConvention.cs new file mode 100644 index 00000000..dbf0b2fe --- /dev/null +++ b/Timeline/Swagger/ApiConvention.cs @@ -0,0 +1,15 @@ +using Microsoft.AspNetCore.Mvc;
+
+[assembly: ApiConventionType(typeof(Timeline.Controllers.ApiConvention))]
+
+namespace Timeline.Controllers
+{
+ // There is some bug if nullable is enable. So disable it.
+#nullable disable
+ /// <summary>
+ /// My api convention.
+ /// </summary>
+ public static class ApiConvention
+ {
+ }
+}
diff --git a/Timeline/Swagger/DefaultDescriptionOperationProcessor.cs b/Timeline/Swagger/DefaultDescriptionOperationProcessor.cs new file mode 100644 index 00000000..4967cc6a --- /dev/null +++ b/Timeline/Swagger/DefaultDescriptionOperationProcessor.cs @@ -0,0 +1,39 @@ +using NSwag.Generation.Processors;
+using NSwag.Generation.Processors.Contexts;
+using System.Collections.Generic;
+
+namespace Timeline.Swagger
+{
+ /// <summary>
+ /// Swagger operation processor that adds default description to response.
+ /// </summary>
+ public class DefaultDescriptionOperationProcessor : IOperationProcessor
+ {
+ private readonly Dictionary<string, string> defaultDescriptionMap = new Dictionary<string, string>
+ {
+ ["200"] = "Succeeded to perform the operation.",
+ ["304"] = "Item does not change.",
+ ["400"] = "See code and message for error info.",
+ ["401"] = "You need to log in to perform this operation.",
+ ["403"] = "You have no permission to perform the operation.",
+ ["404"] = "Item does not exist. See code and message for error info."
+ };
+
+ /// <inheritdoc/>
+ public bool Process(OperationProcessorContext context)
+ {
+ var responses = context.OperationDescription.Operation.Responses;
+
+ foreach (var (httpStatusCode, res) in responses)
+ {
+ if (!string.IsNullOrEmpty(res.Description)) continue;
+ if (defaultDescriptionMap.ContainsKey(httpStatusCode))
+ {
+ res.Description = defaultDescriptionMap[httpStatusCode];
+ }
+ }
+
+ return true;
+ }
+ }
+}
|