Merge pull request #28 from IgniteUI/dTsvetkov/add-swagger-anotations

zdrawku · web-flow · commit 8d3739e5f3ca · 2023-11-28T16:51:38.000+02:00
Add swagger annotations and formats to SalesController
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
             {
diff --git a/NorthwindCRUD/Services/OrderService.cs b/NorthwindCRUD/Services/OrderService.cs
@@ -76,17 +76,17 @@ public OrderDb Create(OrderDb model)
         {
             if (this.dataContext.Customers.FirstOrDefault(c => c.CustomerId == model.CustomerId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Customer), model.CustomerId?.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Customer), model.CustomerId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             if (this.dataContext.Employees.FirstOrDefault(e => e.EmployeeId == model.EmployeeId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Employee), model.EmployeeId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Employee), model.EmployeeId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             if (this.dataContext.Shippers.FirstOrDefault(s => s.ShipperId == model.ShipperId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Shipper), model.ShipperId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Shipper), model.ShipperId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             var id = IdGenerator.CreateDigitsId();
@@ -123,12 +123,12 @@ public OrderDb Create(OrderDb model)
 
             if (this.dataContext.Employees.FirstOrDefault(e => e.EmployeeId == model.EmployeeId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Employee), model.EmployeeId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Employee), model.EmployeeId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             if (this.dataContext.Shippers.FirstOrDefault(s => s.ShipperId == model.ShipperId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Shipper), model.ShipperId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Shipper), model.ShipperId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             var orderEntity = this.dataContext.Orders
diff --git a/NorthwindCRUD/Services/ProductService.cs b/NorthwindCRUD/Services/ProductService.cs
@@ -45,12 +45,12 @@ public ProductDb Create(ProductDb model)
         {
             if (this.dataContext.Categories.FirstOrDefault(c => c.CategoryId == model.CategoryId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Category), model.CategoryId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Category), model.CategoryId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             if (this.dataContext.Suppliers.FirstOrDefault(s => s.SupplierId == model.SupplierId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Supplier), model.SupplierId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Supplier), model.SupplierId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             var id = IdGenerator.CreateDigitsId();
@@ -75,12 +75,12 @@ public ProductDb Create(ProductDb model)
         {
             if (this.dataContext.Categories.FirstOrDefault(c => c.CategoryId == model.CategoryId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Category), model.CategoryId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Category), model.CategoryId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             if (this.dataContext.Suppliers.FirstOrDefault(s => s.SupplierId == model.SupplierId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Supplier), model.SupplierId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Supplier), model.SupplierId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             var productEntity = this.dataContext.Products.FirstOrDefault(p => p.ProductId == model.ProductId);
diff --git a/NorthwindCRUD/Services/TerritoryService.cs b/NorthwindCRUD/Services/TerritoryService.cs
@@ -33,7 +33,7 @@ public TerritoryDb Create(TerritoryDb model)
         {
             if (this.dataContext.Regions.FirstOrDefault(r => r.RegionId == model.RegionId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Region), model.RegionId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Region), model.RegionId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             var id = IdGenerator.CreateDigitsId().ToString(CultureInfo.InvariantCulture);
@@ -58,7 +58,7 @@ public TerritoryDb Create(TerritoryDb model)
         {
             if (this.dataContext.Regions.FirstOrDefault(r => r.RegionId == model.RegionId) == null)
             {
-                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Region), model.RegionId.ToString()));
+                throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Region), model.RegionId?.ToString(CultureInfo.InvariantCulture)));
             }
 
             var territoryEntity = this.dataContext.Territories.FirstOrDefault(p => p.TerritoryId == model.TerritoryId);

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`	`{`
Original file line number	Diff line number	Diff line change
`@@ -76,17 +76,17 @@ public OrderDb Create(OrderDb model)`
`76`	`76`	`{`
`77`	`77`	`if (this.dataContext.Customers.FirstOrDefault(c => c.CustomerId == model.CustomerId) == null)`
`78`	`78`	`{`
`79`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Customer), model.CustomerId?.ToString()));`
	`79`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Customer), model.CustomerId?.ToString(CultureInfo.InvariantCulture)));`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`if (this.dataContext.Employees.FirstOrDefault(e => e.EmployeeId == model.EmployeeId) == null)`
`83`	`83`	`{`
`84`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Employee), model.EmployeeId.ToString()));`
	`84`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Employee), model.EmployeeId?.ToString(CultureInfo.InvariantCulture)));`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`if (this.dataContext.Shippers.FirstOrDefault(s => s.ShipperId == model.ShipperId) == null)`
`88`	`88`	`{`
`89`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Shipper), model.ShipperId.ToString()));`
	`89`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Shipper), model.ShipperId?.ToString(CultureInfo.InvariantCulture)));`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`var id = IdGenerator.CreateDigitsId();`
`@@ -123,12 +123,12 @@ public OrderDb Create(OrderDb model)`
`123`	`123`
`124`	`124`	`if (this.dataContext.Employees.FirstOrDefault(e => e.EmployeeId == model.EmployeeId) == null)`
`125`	`125`	`{`
`126`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Employee), model.EmployeeId.ToString()));`
	`126`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Employee), model.EmployeeId?.ToString(CultureInfo.InvariantCulture)));`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`if (this.dataContext.Shippers.FirstOrDefault(s => s.ShipperId == model.ShipperId) == null)`
`130`	`130`	`{`
`131`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Shipper), model.ShipperId.ToString()));`
	`131`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Shipper), model.ShipperId?.ToString(CultureInfo.InvariantCulture)));`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`var orderEntity = this.dataContext.Orders`
Original file line number	Diff line number	Diff line change
`@@ -45,12 +45,12 @@ public ProductDb Create(ProductDb model)`
`45`	`45`	`{`
`46`	`46`	`if (this.dataContext.Categories.FirstOrDefault(c => c.CategoryId == model.CategoryId) == null)`
`47`	`47`	`{`
`48`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Category), model.CategoryId.ToString()));`
	`48`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Category), model.CategoryId?.ToString(CultureInfo.InvariantCulture)));`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`if (this.dataContext.Suppliers.FirstOrDefault(s => s.SupplierId == model.SupplierId) == null)`
`52`	`52`	`{`
`53`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Supplier), model.SupplierId.ToString()));`
	`53`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Supplier), model.SupplierId?.ToString(CultureInfo.InvariantCulture)));`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`var id = IdGenerator.CreateDigitsId();`
`@@ -75,12 +75,12 @@ public ProductDb Create(ProductDb model)`
`75`	`75`	`{`
`76`	`76`	`if (this.dataContext.Categories.FirstOrDefault(c => c.CategoryId == model.CategoryId) == null)`
`77`	`77`	`{`
`78`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Category), model.CategoryId.ToString()));`
	`78`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Category), model.CategoryId?.ToString(CultureInfo.InvariantCulture)));`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`if (this.dataContext.Suppliers.FirstOrDefault(s => s.SupplierId == model.SupplierId) == null)`
`82`	`82`	`{`
`83`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Supplier), model.SupplierId.ToString()));`
	`83`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Supplier), model.SupplierId?.ToString(CultureInfo.InvariantCulture)));`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`var productEntity = this.dataContext.Products.FirstOrDefault(p => p.ProductId == model.ProductId);`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public TerritoryDb Create(TerritoryDb model)`
`33`	`33`	`{`
`34`	`34`	`if (this.dataContext.Regions.FirstOrDefault(r => r.RegionId == model.RegionId) == null)`
`35`	`35`	`{`
`36`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Region), model.RegionId.ToString()));`
	`36`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Region), model.RegionId?.ToString(CultureInfo.InvariantCulture)));`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`var id = IdGenerator.CreateDigitsId().ToString(CultureInfo.InvariantCulture);`
`@@ -58,7 +58,7 @@ public TerritoryDb Create(TerritoryDb model)`
`58`	`58`	`{`
`59`	`59`	`if (this.dataContext.Regions.FirstOrDefault(r => r.RegionId == model.RegionId) == null)`
`60`	`60`	`{`
`61`		`- throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Region), model.RegionId.ToString()));`
	`61`	`+ throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, StringTemplates.InvalidEntityMessage, nameof(model.Region), model.RegionId?.ToString(CultureInfo.InvariantCulture)));`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`var territoryEntity = this.dataContext.Territories.FirstOrDefault(p => p.TerritoryId == model.TerritoryId);`