[#1] add content type display

Author: i4004

src/Simplify.Web.Swagger/ControllerActionsFactory.cs

@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text.RegularExpressions;
-using Microsoft.AspNetCore.Mvc;
 using Microsoft.OpenApi.Models;
 using Simplify.Web.Meta;
 
@@ -96,22 +95,25 @@ private static IDictionary<int, OpenApiResponse> CreateResponses(Type controller
 		{
 			var items = new Dictionary<int, OpenApiResponse>();
 
-			var attributes = controllerType.GetCustomAttributes(typeof(ProducesResponseTypeAttribute), false);
+			var attributes = controllerType.GetCustomAttributes(typeof(ProducesResponseAttribute), false);
 
-			foreach (ProducesResponseTypeAttribute item in attributes)
+			foreach (ProducesResponseAttribute item in attributes)
 				items.Add(item.StatusCode, CreateResponse(item));
 
 			return items;
 		}
 
-		private static OpenApiResponse CreateResponse(ProducesResponseTypeAttribute producesResponse)
+		private static OpenApiResponse CreateResponse(ProducesResponseAttribute producesResponse)
 		{
 			var response = new OpenApiResponse();
 
 			response.Description = ResponseDescriptionMap
 				.FirstOrDefault((entry) => Regex.IsMatch(producesResponse.StatusCode.ToString(), entry.Key))
 				.Value;
 
+			foreach (var item in producesResponse.ContentTypes.Distinct())
+				response.Content.Add(item, new OpenApiMediaType());
+
 			return response;
 		}
 

src/Simplify.Web.Swagger/ProducesResponseAttribute.cs

@@ -0,0 +1,61 @@
+using System;
+using System.Collections.Generic;
+
+namespace Simplify.Web.Swagger;
+
+/// <summary>
+/// A filter that specifies the type of the value and status code returned by the controller.
+/// </summary>
+[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
+public class ProducesResponseAttribute : Attribute
+{
+	/// <summary>
+	/// Initializes an instance of <see cref="ProducesResponseAttribute"/>.
+	/// </summary>
+	/// <param name="statusCode">The HTTP response status code.</param>
+	/// <param name="contentType">The content type associated with the response.</param>
+	/// <param name="additionalContentTypes">Additional content types supported by the response.</param>
+	public ProducesResponseAttribute(int statusCode, string? contentType, params string[] additionalContentTypes) :
+		this(statusCode, null, contentType, additionalContentTypes)
+	{
+	}
+
+	/// <summary>
+	/// Initializes an instance of <see cref="ProducesResponseAttribute"/>.
+	/// </summary>
+	/// <param name="statusCode">The HTTP response status code.</param>
+	/// <param name="type">The <see cref="Type"/> of object that is going to be written in the response.</param>
+	/// <param name="contentType">The content type associated with the response.</param>
+	/// <param name="additionalContentTypes">Additional content types supported by the response.</param>
+	public ProducesResponseAttribute(int statusCode, Type? type = null, string? contentType = null, params string[] additionalContentTypes)
+	{
+		StatusCode = statusCode;
+		Type = type;
+
+		if (!string.IsNullOrEmpty(contentType))
+			ContentTypes.Add(contentType!);
+
+		for (var i = 0; i < additionalContentTypes.Length; i++)
+		{
+			if (string.IsNullOrEmpty(additionalContentTypes[i]))
+				continue;
+
+			ContentTypes.Add(additionalContentTypes[i]);
+		}
+	}
+
+	/// <summary>
+	/// Gets the HTTP status code of the response.
+	/// </summary>
+	public int StatusCode { get; }
+
+	/// <summary>
+	/// Gets the type of the value returned by a controller.
+	/// </summary>
+	public Type? Type { get; }
+
+	/// <summary>
+	/// Gets the HTTP content types of the response
+	/// </summary>
+	public IList<string> ContentTypes { get; } = new List<string>();
+}

src/TesterApp/Controllers/Api/v1/Users/DeleteController.cs

@@ -1,16 +1,16 @@
 using Microsoft.AspNetCore.Mvc;
 using Simplify.Web;
 using Simplify.Web.Attributes;
+using Simplify.Web.Swagger;
 
 namespace TesterApp.Controllers.Api.v1.Users;
 
 [Delete("/api/v1/users/{id:int}")]
 [Authorize]
 [ApiVersion("1.0")]
-[Produces("application/text")]
-[ProducesResponseType(StatusCodes.Status204NoContent)]
-[ProducesResponseType(StatusCodes.Status400BadRequest)]
-[ProducesResponseType(StatusCodes.Status500InternalServerError)]
+[ProducesResponse(StatusCodes.Status204NoContent)]
+[ProducesResponse(StatusCodes.Status400BadRequest)]
+[ProducesResponse(StatusCodes.Status500InternalServerError)]
 public class DeleteController : Simplify.Web.Controller
 {
 	public override ControllerResponse Invoke()

src/TesterApp/Controllers/Api/v1/Users/GetController.cs

@@ -2,15 +2,15 @@
 using Simplify.Web;
 using Simplify.Web.Attributes;
 using Simplify.Web.Json.Responses;
+using Simplify.Web.Swagger;
 using TesterApp.ViewModels;
 
 namespace TesterApp.Controllers.Api.v1.Users;
 
 [Get("/api/v1/users/{id:int}")]
 [ApiVersion("1.0")]
-[Produces("application/json")]
-[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(UserViewModel))]
-[ProducesResponseType(StatusCodes.Status500InternalServerError)]
+[ProducesResponse(StatusCodes.Status200OK, typeof(UserViewModel), "application/json")]
+[ProducesResponse(StatusCodes.Status500InternalServerError)]
 public class GetController : Simplify.Web.Controller
 {
 	public override ControllerResponse Invoke() =>

src/TesterApp/Controllers/Api/v1/Users/GetMultipleController.cs

@@ -2,15 +2,16 @@
 using Simplify.Web;
 using Simplify.Web.Attributes;
 using Simplify.Web.Json.Responses;
+using Simplify.Web.Swagger;
 using TesterApp.ViewModels;
 
 namespace TesterApp.Controllers.Api.v1.Users;
 
 [Get("/api/v1/users")]
 [ApiVersion("1.0")]
-[Produces("application/json")]
-[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(IList<UserViewModel>))]
-[ProducesResponseType(StatusCodes.Status500InternalServerError)]
+// [Produces("application/json")]
+[ProducesResponse(StatusCodes.Status200OK, typeof(IList<UserViewModel>), "application/json")]
+[ProducesResponse(StatusCodes.Status500InternalServerError)]
 public class GetMultipleController : Simplify.Web.Controller
 {
 	public override ControllerResponse Invoke()

src/TesterApp/Controllers/StatusController.cs

@@ -1,14 +1,14 @@
-using Simplify.Web;
+using System.Net.Mime;
+using Simplify.Web;
 using Simplify.Web.Attributes;
+using Simplify.Web.Swagger;
 
 namespace TesterApp.Controllers
 {
 	[Get("status")]
+	[ProducesResponse(StatusCodes.Status200OK, MediaTypeNames.Text.Plain)]
 	public class StatusController : Controller
 	{
-		public override ControllerResponse Invoke()
-		{
-			return Content("Service is running!");
-		}
+		public override ControllerResponse Invoke() => Content("Service is running!", MediaTypeNames.Text.Plain);
 	}
 }