Add Response Types

Author: maurogioberti

Poc.TextProcessor.Presentation.RestApi/Controllers/TextController.cs

@@ -27,21 +27,27 @@ public TextController(ITextService textService,
 
         [HttpGet("Options")]
         [Produces("application/json", "application/xml")]
-        public SortCollection GetOptions()
+        [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(SortCollection))]
+        public IActionResult GetOptions()
         {
-            return _textSortService.List();
+            var sortOptions = _textSortService.List();
+            return Ok(sortOptions);
         }
 
         [HttpGet("Statistics")]
         [Produces("application/json", "application/xml")]
-        public Statistics GetStatistics([FromQuery] string textToAnalyze)
+        [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(Statistics))]
+        public IActionResult GetStatistics([FromQuery] string textToAnalyze)
         {
-            return _textService.GetStatistics(textToAnalyze);
+            var textStatics = _textService.GetStatistics(textToAnalyze);
+            return Ok(textStatics);
         }
 
         [HttpGet("OrderedText")]
         [Produces("application/json", "application/xml")]
         [ResponseOnException(HttpStatusCode.InternalServerError, typeof(SortingException))]
+        [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(string))]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
         public IActionResult GetOrderedText([FromQuery] string textToOrder, string orderOption)
         {
             if (Enum.TryParse(orderOption, true, out SortOption orderOptionEnum))

Poc.TextProcessor.Presentation.RestApi/Infrastructure/FilterAttributes/ExceptionHandlingFilter.cs

@@ -2,6 +2,7 @@
 using Microsoft.AspNetCore.Mvc.Controllers;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Poc.TextProcessor.CrossCutting.Globalization;
+using System.Text;
 
 namespace Poc.TextProcessor.Presentation.RestApi.Infrastructure.FilterAttributes
 {
@@ -15,12 +16,22 @@ public void OnException(ExceptionContext context)
 
             if (responseOnExceptionAttribute != null && responseOnExceptionAttribute.ExceptionTypes.Contains(exceptionType))
             {
-                context.Result = new ObjectResult(Messages.UnexpectedError)
+                var responseContent = HandleExceptionResponse(context.Exception.Message);
+                context.Result = new ObjectResult(responseContent)
                 {
                     StatusCode = (int)responseOnExceptionAttribute.ResponseCode
                 };
                 context.ExceptionHandled = true;
             }
         }
+
+        private static string HandleExceptionResponse(string exceptionMessage)
+        {
+            var messageBuilder = new StringBuilder();
+            messageBuilder.AppendLine(Messages.UnexpectedError);
+            messageBuilder.AppendLine(exceptionMessage);
+
+            return messageBuilder.ToString();
+        }
     }
 }