Add swagger annotations and formats to SalesController

dobromirts · dobromirts · commit a25300ab67ea · 2023-11-28T14:12:45.000+02:00
diff --git a/NorthwindCRUD/Controllers/SalesController.cs b/NorthwindCRUD/Controllers/SalesController.cs
@@ -4,6 +4,7 @@
 using Microsoft.AspNetCore.Mvc;
 using NorthwindCRUD.Models.Dtos;
 using NorthwindCRUD.Services;
+using Swashbuckle.AspNetCore.Annotations;
 
 namespace NorthwindCRUD.Controllers
 {
@@ -41,8 +42,8 @@ public ActionResult<SalesDto[]> GetSalesByCategoryAndYear([FromQuery] [Required]
         [Authorize]
         public ActionResult<SalesDto[]> GetSalesByCountry(
             string country,
-            [FromQuery] [Required] string startDate,
-            [FromQuery] [Required] string endDate)
+            [FromQuery] [Required] [DataType(DataType.Date)] [SwaggerParameter("Start date in YYYY-MM-DD format")] string startDate,
+            [FromQuery] [Required] [DataType(DataType.Date)] [SwaggerParameter("End date in YYYY-MM-DD format")] string endDate)
         {
             try
             {

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`using Microsoft.AspNetCore.Mvc;`
`5`	`5`	`using NorthwindCRUD.Models.Dtos;`
`6`	`6`	`using NorthwindCRUD.Services;`
	`7`	`+using Swashbuckle.AspNetCore.Annotations;`
`7`	`8`
`8`	`9`	`namespace NorthwindCRUD.Controllers`
`9`	`10`	`{`
`@@ -41,8 +42,8 @@ public ActionResult<SalesDto[]> GetSalesByCategoryAndYear([FromQuery] [Required]`
`41`	`42`	`[Authorize]`
`42`	`43`	`public ActionResult<SalesDto[]> GetSalesByCountry(`
`43`	`44`	`string country,`
`44`		`- [FromQuery] [Required] string startDate,`
`45`		`- [FromQuery] [Required] string endDate)`
	`45`	`+ [FromQuery] [Required] [DataType(DataType.Date)] [SwaggerParameter("Start date in YYYY-MM-DD format")] string startDate,`
	`46`	`+ [FromQuery] [Required] [DataType(DataType.Date)] [SwaggerParameter("End date in YYYY-MM-DD format")] string endDate)`
`46`	`47`	`{`
`47`	`48`	`try`
`48`	`49`	`{`