From 53888df71f7580bf169dfab3d13d313cf96d26df Mon Sep 17 00:00:00 2001
From: crupest <crupest@outlook.com>
Date: Fri, 21 Aug 2020 21:25:33 +0800
Subject: ...

---
 .../DefaultDescriptionOperationProcessor.cs        | 39 ++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Timeline/Swagger/DefaultDescriptionOperationProcessor.cs

(limited to 'Timeline/Swagger/DefaultDescriptionOperationProcessor.cs')

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;
+        }
+    }
+}
-- 
cgit v1.2.3