Merge pull request #34 from IgniteUI/dgdimitrov/openapi-schema-validations

zdrawku · web-flow · commit 41a657935c5e · 2024-10-08T11:07:53.000+03:00
OpenAPI schema validations
diff --git a/NorthwindCRUD/Controllers/CategoriesController.cs b/NorthwindCRUD/Controllers/CategoriesController.cs
@@ -1,5 +1,6 @@
 namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -51,8 +52,8 @@ public ActionResult<CategoryDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetCategoriesWithSkip")]
         public ActionResult<PagedResultDto<CategoryDto>> GetCategoriesWithSkip(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Controllers/CustomersController.cs b/NorthwindCRUD/Controllers/CustomersController.cs
@@ -1,12 +1,12 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Services;
-    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -51,8 +51,8 @@ public ActionResult<CustomerDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetCustomersWithSkip")]
         public ActionResult<PagedResultDto<CustomerDto>> GetCustomersWithSkip(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Controllers/EmployeesController.cs b/NorthwindCRUD/Controllers/EmployeesController.cs
@@ -1,12 +1,12 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Services;
-    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -53,8 +53,8 @@ public ActionResult<EmployeeDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetEmployeesWithSkip")]
         public ActionResult<PagedResultDto<EmployeeDto>> GetPagedEmployees(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Controllers/OrdersController.cs b/NorthwindCRUD/Controllers/OrdersController.cs
@@ -1,5 +1,6 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -56,8 +57,8 @@ public ActionResult<OrderDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetPagedOrders")]
         public ActionResult<PagedResultDto<OrderDto>> GetAllOrders(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Controllers/ProductsController.cs b/NorthwindCRUD/Controllers/ProductsController.cs
@@ -1,14 +1,12 @@
 namespace NorthwindCRUD.Controllers
 {
-    using System.Globalization;
-    using System.Reflection;
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Services;
-    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -57,8 +55,8 @@ public ActionResult<ProductDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetPagedProducts")]
         public ActionResult<PagedResultDto<ProductDto>> GetAllProducts(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Controllers/RegionsController.cs b/NorthwindCRUD/Controllers/RegionsController.cs
@@ -1,13 +1,12 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
-    using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
-    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -52,8 +51,8 @@ public ActionResult<RegionDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetPagedRegions")]
         public ActionResult<PagedResultDto<RegionDto>> GetAllRegions(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Controllers/ShippersController.cs b/NorthwindCRUD/Controllers/ShippersController.cs
@@ -1,13 +1,12 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
-    using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
-    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -52,8 +51,8 @@ public ActionResult<ShipperDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetPagedShippersWithSkip")]
         public ActionResult<PagedResultDto<ShipperDto>> GetPagedShippersWithSkip(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Controllers/SuppliersController.cs b/NorthwindCRUD/Controllers/SuppliersController.cs
@@ -1,13 +1,12 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
-    using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
-    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -52,8 +51,8 @@ public ActionResult<SupplierDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetPagedSuppliers")]
         public ActionResult<PagedResultDto<SupplierDto>> GetAllSuppliers(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Controllers/TerritoriesController.cs b/NorthwindCRUD/Controllers/TerritoriesController.cs
@@ -1,13 +1,12 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
-    using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
-    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -54,8 +53,8 @@ public ActionResult<TerritoryDto[]> GetAll()
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetPagedTerritories")]
         public ActionResult<PagedResultDto<TerritoryDto>> GetAllTerritories(
-            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
-            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerSkipParameter][Range(0, int.MaxValue)] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter][Range(0, int.MaxValue)] int? top,
             [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
diff --git a/NorthwindCRUD/Filters/EnumSchemaFilter.cs b/NorthwindCRUD/Filters/EnumSchemaFilter.cs
@@ -0,0 +1,22 @@
+﻿using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace NorthwindCRUD.Filters
+{
+    public class EnumSchemaFilter : ISchemaFilter
+    {
+        public void Apply(OpenApiSchema schema, SchemaFilterContext context)
+        {
+            if (context.Type.IsEnum)
+            {
+                var enumValues = Enum.GetValues(context.Type)
+                    .Cast<object>()
+                    .Select(e => new OpenApiString(e.ToString()))
+                    .ToList<IOpenApiAny>();
+
+                schema.Enum = enumValues;
+            }
+        }
+    }
+}
diff --git a/NorthwindCRUD/Helpers/Enums.cs b/NorthwindCRUD/Helpers/Enums.cs
@@ -0,0 +1,19 @@
+﻿using System.Runtime.Serialization;
+
+namespace NorthwindCRUD.Helpers
+{
+    public class Enums
+    {
+        public enum Shipping
+        {
+            [EnumMember(Value = "SeaFreight")]
+            SeaFreight,
+
+            [EnumMember(Value = "GroundTransport")]
+            GroundTransport,
+
+            [EnumMember(Value = "AirCargo")]
+            AirCargo,
+        }
+    }
+}
diff --git a/NorthwindCRUD/Models/Contracts/IOrder.cs b/NorthwindCRUD/Models/Contracts/IOrder.cs
@@ -1,6 +1,5 @@
-﻿using NorthwindCRUD.Models.DbModels;
-using NorthwindCRUD.Models.Dtos;
-using NorthwindCRUD.Models.InputModels;
+﻿using NorthwindCRUD.Models.Dtos;
+using static NorthwindCRUD.Helpers.Enums;
 
 namespace NorthwindCRUD.Models.Contracts
 {
@@ -18,12 +17,14 @@ public interface IOrder
 
         string RequiredDate { get; set; }
 
-        int ShipVia { get; set; }
+        Shipping? ShipVia { get; set; }
 
         double Freight { get; set; }
 
         string ShipName { get; set; }
 
+        public bool Completed { get; set; }
+
         AddressDto ShipAddress { get; set; }
     }
 }
diff --git a/NorthwindCRUD/Models/DbModels/OrderDb.cs b/NorthwindCRUD/Models/DbModels/OrderDb.cs
@@ -43,6 +43,8 @@ public OrderDb()
 
         public string? ShipAddressId { get; set; }
 
+        public bool Completed { get; set; }
+
         public AddressDb? ShipAddress { get; set; }
     }
 }
diff --git a/NorthwindCRUD/Models/Dtos/AddressDto.cs b/NorthwindCRUD/Models/Dtos/AddressDto.cs
@@ -1,19 +1,27 @@
-﻿namespace NorthwindCRUD.Models.Dtos
-{
-    using NorthwindCRUD.Models.Contracts;
+﻿using System.ComponentModel.DataAnnotations;
+using NorthwindCRUD.Models.Contracts;
 
+namespace NorthwindCRUD.Models.Dtos
+{
     public class AddressDto : IAddress
     {
+        [StringLength(100, ErrorMessage = "Street cannot exceed 100 characters.")]
         public string Street { get; set; }
 
+        [StringLength(50, ErrorMessage = "City cannot exceed 50 characters.")]
         public string City { get; set; }
 
+        [StringLength(50, ErrorMessage = "Region cannot exceed 50 characters.")]
         public string Region { get; set; }
 
+        [StringLength(20, ErrorMessage = "Postal code cannot exceed 20 characters.")]
         public string PostalCode { get; set; }
 
+        [Required(ErrorMessage = "Country is required.")]
+        [StringLength(50, ErrorMessage = "Country cannot exceed 50 characters.")]
         public string Country { get; set; }
 
+        [RegularExpression(@"^\+?[1-9]\d{1,14}$", ErrorMessage = "Phone number is not valid.")]
         public string? Phone { get; set; }
     }
 }
diff --git a/NorthwindCRUD/Models/Dtos/CategoryDetailsDto.cs b/NorthwindCRUD/Models/Dtos/CategoryDetailsDto.cs
@@ -1,9 +1,11 @@
-﻿using NorthwindCRUD.Models.Contracts;
+﻿using System.ComponentModel.DataAnnotations;
+using NorthwindCRUD.Models.Contracts;
 
 namespace NorthwindCRUD.Models.Dtos
 {
     public class CategoryDetailsDto : CategoryDto, ICategoryDetail
     {
+        [RegularExpression(@"^(http[s]?://.*\.(?:jpg|jpeg|png|gif))$", ErrorMessage = "Picture URL must start with http/s and end with .jpg, .jpeg, .png, or .gif.")]
         public string Picture { get; set; }
     }
 }
diff --git a/NorthwindCRUD/Models/Dtos/CategoryDto.cs b/NorthwindCRUD/Models/Dtos/CategoryDto.cs
@@ -1,13 +1,17 @@
-﻿using NorthwindCRUD.Models.Contracts;
+﻿using System.ComponentModel.DataAnnotations;
+using NorthwindCRUD.Models.Contracts;
 
 namespace NorthwindCRUD.Models.Dtos
 {
     public class CategoryDto : ICategory
     {
         public int CategoryId { get; set; }
 
+        [StringLength(500, ErrorMessage = "Description cannot exceed 500 characters.")]
         public string Description { get; set; }
 
+        [Required(ErrorMessage = "Name is required.")]
+        [StringLength(50, MinimumLength = 3, ErrorMessage = "Name must be between 3 and 50 characters.")]
         public string Name { get; set; }
     }
 }
diff --git a/NorthwindCRUD/Models/Dtos/CustomerDto.cs b/NorthwindCRUD/Models/Dtos/CustomerDto.cs
@@ -7,11 +7,14 @@ public class CustomerDto : ICustomer
     {
         public string CustomerId { get; set; }
 
-        [Required]
+        [Required(ErrorMessage = "Company Name is required.")]
+        [StringLength(100, ErrorMessage = "Company Name cannot exceed 100 characters.")]
         public string CompanyName { get; set; }
 
+        [StringLength(50, ErrorMessage = "Contact Name cannot exceed 50 characters.")]
         public string ContactName { get; set; }
 
+        [StringLength(50, ErrorMessage = "Contact Title cannot exceed 50 characters.")]
         public string ContactTitle { get; set; }
 
         public AddressDto Address { get; set; }
diff --git a/NorthwindCRUD/Models/Dtos/EmployeeDto.cs b/NorthwindCRUD/Models/Dtos/EmployeeDto.cs
diff --git a/NorthwindCRUD/Models/Dtos/OrderDetailDto.cs b/NorthwindCRUD/Models/Dtos/OrderDetailDto.cs
diff --git a/NorthwindCRUD/Models/Dtos/OrderDto.cs b/NorthwindCRUD/Models/Dtos/OrderDto.cs
diff --git a/NorthwindCRUD/Models/Dtos/ProductDto.cs b/NorthwindCRUD/Models/Dtos/ProductDto.cs
diff --git a/NorthwindCRUD/Models/Dtos/SalesDto.cs b/NorthwindCRUD/Models/Dtos/SalesDto.cs
diff --git a/NorthwindCRUD/Models/Dtos/ShipperDto.cs b/NorthwindCRUD/Models/Dtos/ShipperDto.cs
diff --git a/NorthwindCRUD/Models/Dtos/SupplierDto.cs b/NorthwindCRUD/Models/Dtos/SupplierDto.cs
diff --git a/NorthwindCRUD/Program.cs b/NorthwindCRUD/Program.cs
