Расширенное описание ошибок Swagger (#1)

* Вывод списка ошибок с одинаковым StatusCode

* Добавить метод для получения описания ошибки

* Добавить атрибуты для разных ошибок

Author: qdimka

src/SmartHead.Essentials.Application/SmartHead.Essentials.Application.csproj

@@ -7,7 +7,7 @@
     <IsPackable>true</IsPackable>
     <Authors>Rustam Asylgareev</Authors>
     <PackageProjectUrl>https://github.com/smarthead-dev/SmartHead.Essentials</PackageProjectUrl>
-    <Version>0.0.9</Version>
+    <Version>0.0.10</Version>
     <Company>SmartHead</Company>
     <IsTestProject>false</IsTestProject>
     <Description>SmartHead.Essentials.Application</Description>

src/SmartHead.Essentials.Application/Swagger/Attributes/BadRequestAttribute.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Net;
+
+namespace SmartHead.Essentials.Application.Swagger.Attributes
+{
+    public class BadRequestAttribute : ReturnsAttribute
+    {
+        public BadRequestAttribute(string subStatus, string description = null, Type type = null) 
+            :base((int)HttpStatusCode.BadRequest, subStatus, description, type)
+        {
+        }
+    }
+}

src/SmartHead.Essentials.Application/Swagger/Attributes/CreatedAttribute.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Net;
+
+namespace SmartHead.Essentials.Application.Swagger.Attributes
+{
+    public class CreatedAttribute : ReturnsAttribute
+    {
+        public CreatedAttribute(string description = null, Type type = null) 
+            : base((int)HttpStatusCode.Created, null, description, type)
+        {
+        }
+    }
+}

src/SmartHead.Essentials.Application/Swagger/Attributes/ForbiddenAttribute.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Net;
+
+namespace SmartHead.Essentials.Application.Swagger.Attributes
+{
+    public class ForbiddenAttribute : ReturnsAttribute
+    {
+        public ForbiddenAttribute(string subStatus = null, string description = null, Type type = null) 
+            : base((int)HttpStatusCode.Forbidden, subStatus, description, type)
+        {
+        }
+    }
+}

src/SmartHead.Essentials.Application/Swagger/Attributes/InternalServerErrorAttribute.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Net;
+
+namespace SmartHead.Essentials.Application.Swagger.Attributes
+{
+    public class InternalServerErrorAttribute : ReturnsAttribute
+    {
+        public InternalServerErrorAttribute(string subStatus = null, string description = null, Type type = null) 
+            : base((int)HttpStatusCode.InternalServerError, subStatus, description, type)
+        {
+        }
+    }
+}

src/SmartHead.Essentials.Application/Swagger/Attributes/NoContentAttribute.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Net;
+
+namespace SmartHead.Essentials.Application.Swagger.Attributes
+{
+    public class NoContentAttribute : ReturnsAttribute
+    {
+        public NoContentAttribute(string description = null) 
+            : base((int)HttpStatusCode.NoContent, null, description, null)
+        {
+        }
+    }
+}

src/SmartHead.Essentials.Application/Swagger/Attributes/OkAttribute.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Net;
+
+namespace SmartHead.Essentials.Application.Swagger.Attributes
+{
+    public class OkAttribute : ReturnsAttribute
+    {
+        public OkAttribute(string description = null, Type type = null) 
+            : base((int)HttpStatusCode.OK, null, description, type)
+        {
+        }
+    }
+}

src/SmartHead.Essentials.Application/Swagger/Attributes/ReturnsAttribute.cs

@@ -0,0 +1,15 @@
+using System;
+using Swashbuckle.AspNetCore.Annotations;
+
+namespace SmartHead.Essentials.Application.Swagger.Attributes
+{
+    public class ReturnsAttribute : SwaggerResponseAttribute
+    {
+        public string SubStatus { get; }
+
+        public ReturnsAttribute(int statusCode, string subStatus, string description = null, Type type = null) : base(statusCode, description, type)
+        {
+            SubStatus = subStatus;
+        }
+    }
+}

src/SmartHead.Essentials.Application/Swagger/BadRequestOperationFilter.cs

@@ -0,0 +1,95 @@
+using System;
+using System.Linq;
+using System.Net;
+using Microsoft.AspNetCore.Mvc.ApiExplorer;
+using Microsoft.AspNetCore.Mvc.ModelBinding;
+using Microsoft.OpenApi.Models;
+using SmartHead.Essentials.Application.Controller;
+using SmartHead.Essentials.Application.Swagger.Attributes;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace SmartHead.Essentials.Application.Swagger
+{
+    public class BadRequestOperationFilter<T> : IOperationFilter
+        where T: IDescriptionProvider
+    {
+        private IDescriptionProvider _descriptionProvider = null;
+
+        public IDescriptionProvider Description => GetDescriptionProvider();
+            
+        public void Apply(OpenApiOperation operation, OperationFilterContext context)
+        {
+            var isController = context.MethodInfo.ReflectedType?.BaseType == typeof(FormattedApiControllerBase) ||
+                               context.MethodInfo.ReflectedType?.BaseType?.BaseType == typeof(FormattedApiControllerBase) ||
+                               context.MethodInfo.ReflectedType?.BaseType?.BaseType?.BaseType == typeof(FormattedApiControllerBase);
+            if (!isController) return;
+            
+            var groups = context.MethodInfo.DeclaringType
+                .GetCustomAttributes(true)
+                .Union(context.MethodInfo.GetCustomAttributes(true))
+                .OfType<ReturnsAttribute>()
+                .Where(x => x.StatusCode == (int)HttpStatusCode.BadRequest)
+                .GroupBy(x => x.StatusCode);
+
+            foreach (var group in groups)
+            {
+                var count = group.Count();
+                var responses = group.ToArray();
+                
+                for (var i = 0; i < count; i++)
+                {
+                    var response = responses[i];
+                    
+                    var key = $"{response.StatusCode}";
+                    if (count > 1)
+                        key += $" ({i + 1} из {count})";
+                    
+                    if (operation.Responses.ContainsKey(response.StatusCode.ToString()))
+                        operation.Responses.Remove(response.StatusCode.ToString());
+
+                    if (operation.Responses.ContainsKey(key)) 
+                        continue;
+                    
+                    var apiResponseType = context
+                        .ApiDescription
+                        .SupportedResponseTypes
+                        .FirstOrDefault(x => x.Type == response.Type);
+
+                    operation.Responses.Add(key, CreateOpenApiResponse(context, response, apiResponseType));
+                }
+            }
+        }
+
+        private OpenApiResponse CreateOpenApiResponse(OperationFilterContext context, ReturnsAttribute response, ApiResponseType apiResponseType) 
+            => new OpenApiResponse()
+            {
+                Description = $"{response.SubStatus}<br/><br/>{Description?.GetValue(response.SubStatus) ?? response.Description}",
+                Content = apiResponseType
+                    ?.ApiResponseFormats
+                    .ToDictionary(x => x.MediaType,
+                        x => CreateResponseMediaType(context, apiResponseType.ModelMetadata))
+            };
+
+        private OpenApiMediaType CreateResponseMediaType(OperationFilterContext context, ModelMetadata modelMetadata) 
+            => new OpenApiMediaType
+            {
+                Schema = context.SchemaGenerator.GenerateSchema(modelMetadata.ModelType, context.SchemaRepository)
+            };
+
+        private IDescriptionProvider GetDescriptionProvider()
+        {
+            try
+            {
+                return _descriptionProvider ??= Activator.CreateInstance<T>();
+            }
+            catch (Exception e)
+            {
+                return null;
+            }
+        }
+    }
+
+    public class BadRequestOperationFilter: BadRequestOperationFilter<DummyDescriptionProvider>
+    {
+    }
+}

src/SmartHead.Essentials.Application/Swagger/Description/DummyDescriptionProvider.cs

@@ -0,0 +1,10 @@
+namespace SmartHead.Essentials.Application.Swagger
+{
+    public class DummyDescriptionProvider : IDescriptionProvider
+    {
+        public string GetValue(string key)
+        {
+            return null;
+        }
+    }
+}