Modified OpenAPI annotations via a better use of Produces

AKlaus · Aug 17, 2022 · b80818a · b80818a
1 parent 8d8e3de
commit b80818a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 12 deletions.
diff --git a/samples/WebApiMinimal/Routes/200OkResponses.cs b/samples/WebApiMinimal/Routes/200OkResponses.cs
@@ -18,18 +18,18 @@ public static void MapSuccessResponses(this IEndpointRouteBuilder app)
 
 		app.MapGet("200OkWithNumber", () => service.GetSuccessWithNumericValue().ToResult())
 		   .WithTags("Success: 200 Ok")
-		   .Produces(StatusCodes.Status200OK, typeof(int));
+		   .Produces<int>();
 
 		app.MapGet("Get200OkWithNumberTask", () => service.GetSuccessWithNumericValueTask().ToResult())
 		   .WithTags("Success: 200 Ok")
-		   .Produces(StatusCodes.Status200OK, typeof(int));
+		   .Produces<int>();
 
 		app.MapGet("Get200OkTupleWithNumber", () => service.GetSuccessWithNumericValueTuple().ToResult())
 		   .WithTags("Success: 200 Ok")
-		   .Produces(StatusCodes.Status200OK, typeof(int));
+		   .Produces<int>();
 
 		app.MapGet("Get200OkTupleWithNumberTask", () => service.GetSuccessWithNumericValueTupleTask().ToResult())
 		   .WithTags("Success: 200 Ok")
-		   .Produces(StatusCodes.Status200OK, typeof(int));
+		   .Produces<int>();
 	}
 }
diff --git a/samples/WebApiMinimal/Routes/201CreatedResponses.cs b/samples/WebApiMinimal/Routes/201CreatedResponses.cs
@@ -1,4 +1,6 @@
-using DomainResults.Examples.Domain;
+using System.Net.Mime;
+
+using DomainResults.Examples.Domain;
 using DomainResults.Mvc;
 
 using Microsoft.AspNetCore.Builder;
@@ -22,35 +24,35 @@ public static void MapSuccessCreatedResponses(this IEndpointRouteBuilder app)
 			                .ToCustomResult(val => Results.CreatedAtRoute("GetById", new { id = val }, val))
 				   )
 		   .WithTags("Success: 201 Created")
-		   .Produces(StatusCodes.Status201Created, typeof(int));
+		   .Produces<int>(StatusCodes.Status201Created);
 
 		app.MapPost("Post201CreatedFromTupleTask", 
 			   () => service
 							.GetSuccessWithNumericValueTupleTask()
 							.ToCustomResult(val => Results.CreatedAtRoute("GetById", new { id = val }, val))
 					)
 		   .WithTags("Success: 201 Created")
-		   .Produces(StatusCodes.Status201Created, typeof(int));
+		   .Produces<int>(StatusCodes.Status201Created);
 
 		app.MapPost("Post201Created", 
 			   () => service
 							.GetSuccessWithNumericValue()
 							.ToCustomResult(val => Results.CreatedAtRoute("GetById", new { id = val }, val))
 			   )
 		   .WithTags("Success: 201 Created")
-		   .Produces(StatusCodes.Status201Created, typeof(int));
+		   .Produces<int>(StatusCodes.Status201Created);
 
 		app.MapPost("Post201CreatedTask", 
 			   () => service
 							.GetSuccessWithNumericValueTask()
 							.ToCustomResult(val => Results.CreatedAtRoute("GetById", new { id = val }, val))
 			   )
 		   .WithTags("Success: 201 Created")
-		   .Produces(StatusCodes.Status201Created, typeof(int));
+		   .Produces<int>(StatusCodes.Status201Created);
 
-		app.MapGet("{id}", (int id) => Results.Ok(new { id }))
+		app.MapGet("{id}", (int id) => Results.Ok($"Sample properties of #{id} record"))
 		   .WithTags("Success: 201 Created")
-		   .WithMetadata(new RouteNameMetadata("GetById"))
-		   .Produces(StatusCodes.Status200OK, typeof(int));
+		   .WithName("GetById")
+		   .Produces<string>(StatusCodes.Status200OK, MediaTypeNames.Text.Plain);
 	}
 }