Merge pull request #19 from asset-t/feature/response-body

Feature/response body

Author: i4004

src/Simplify.Web.Swagger/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.4] - 2023-12-21
+
+### Added
+
+- Response body display and usage
+
 ## [0.3] - 2023-12-20
 
 ### Added

src/Simplify.Web.Swagger/ControllerActionsFactory.cs

@@ -42,7 +42,7 @@ private static ControllerAction CreateControllerAction(HttpMethod method, string
 				Type = HttpMethodToOperationType(method),
 				Path = route.StartsWith("/") ? route : "/" + route,
 				Names = CreateNames(item.ControllerType),
-				Responses = CreateResponses(item.ControllerType),
+				Responses = CreateResponses(item.ControllerType, context),
 				RequestBody = CreateRequestBody(item.ControllerType, context),
 				IsAuthorizationRequired = item.Security != null && item.Security.IsAuthorizationRequired
 			};
@@ -112,19 +112,19 @@ private static OpenApiRequestBody CreateRequestBody(Type controllerType, Documen
 			return request;
 		}
 
-		private static IDictionary<int, OpenApiResponse> CreateResponses(Type controllerType)
+		private static IDictionary<int, OpenApiResponse> CreateResponses(Type controllerType, DocumentFilterContext context)
 		{
 			var items = new Dictionary<int, OpenApiResponse>();
 
 			var attributes = controllerType.GetCustomAttributes(typeof(ProducesResponseAttribute), false);
 
 			foreach (ProducesResponseAttribute item in attributes)
-				items.Add(item.StatusCode, CreateResponse(item));
+				items.Add(item.StatusCode, CreateResponse(item, context));
 
 			return items;
 		}
 
-		private static OpenApiResponse CreateResponse(ProducesResponseAttribute producesResponse)
+		private static OpenApiResponse CreateResponse(ProducesResponseAttribute producesResponse, DocumentFilterContext context)
 		{
 			var response = new OpenApiResponse();
 
@@ -133,7 +133,9 @@ private static OpenApiResponse CreateResponse(ProducesResponseAttribute produces
 				.Value;
 
 			foreach (var item in producesResponse.ContentTypes.Distinct())
-				response.Content.Add(item, new OpenApiMediaType());
+				response.Content.Add(item, producesResponse.Type is null 
+					? new OpenApiMediaType() 
+					: new () {Schema = context.SchemaGenerator.GenerateSchema(producesResponse.Type, context.SchemaRepository)});
 
 			return response;
 		}

src/Simplify.Web.Swagger/Simplify.Web.Swagger.csproj

@@ -9,7 +9,7 @@
 		<SymbolPackageFormat>snupkg</SymbolPackageFormat>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 
-		<Version>0.3</Version>
+		<Version>0.4</Version>
 
 		<Description>Swagger extensions for Simplify.Web web-framework</Description>
 		<Product>Simplify</Product>

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

@@ -1,16 +1,17 @@
-using Microsoft.AspNetCore.Mvc;
+using System.Net.Mime;
+using Microsoft.AspNetCore.Mvc;
 using Simplify.Web;
 using Simplify.Web.Attributes;
 using Simplify.Web.Json.Responses;
+using Simplify.Web.Swagger;
 using TesterApp.ViewModels;
 
 namespace TesterApp.Controllers.Api.v1.Groups;
 
 [Get("/api/v1/groups")]
 [ApiVersion("1.0")]
-[Produces("application/json")]
-[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(IList<GroupViewModel>))]
-[ProducesResponseType(StatusCodes.Status500InternalServerError)]
+[ProducesResponse(StatusCodes.Status200OK, typeof(IList<GroupViewModel>), MediaTypeNames.Application.Json)]
+[ProducesResponse(StatusCodes.Status500InternalServerError)]
 public class GetMultipleController : Simplify.Web.Controller
 {
 	public override ControllerResponse Invoke()