OpenAPI schema validations

ddidgdimitrov-infragistics · hanastasov · commit cf87d3eabd5a · 2025-05-28T10:25:50.000+03:00
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;
@@ -50,8 +51,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,5 +1,6 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -50,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,5 +1,6 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -68,8 +69,8 @@ public ActionResult<OrderDto[]> GetAllAuthorized()
         /// <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
@@ -70,8 +70,8 @@ public ActionResult<OrderDto[]> GetAllAuthorized()
         /// <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,5 +1,6 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -50,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,5 +1,6 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -50,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,5 +1,6 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -50,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,5 +1,6 @@
 ﻿namespace NorthwindCRUD.Controllers
 {
+    using System.ComponentModel.DataAnnotations;
     using AutoMapper;
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
@@ -52,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/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
@@ -17,6 +17,7 @@ public interface IOrder
 
         string RequiredDate { get; set; }
 
+        Shipping? ShipVia { get; set; }
         Shipping? ShipVia { get; set; }
 
         double Freight { get; set; }
@@ -25,6 +26,8 @@ public interface IOrder
 
         public bool Completed { get; set; }
 
+        public bool Completed { get; set; }
+
         AddressDto ShipAddress { get; set; }
     }
 }
diff --git a/NorthwindCRUD/Models/Dtos/AddressDto.cs b/NorthwindCRUD/Models/Dtos/AddressDto.cs
@@ -5,17 +5,23 @@ 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
@@ -5,6 +5,7 @@ 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
@@ -5,11 +5,14 @@ namespace NorthwindCRUD.Models.Dtos
 {
     public class CategoryDto : ICategory
     {
+        [Range(1, int.MaxValue, ErrorMessage = "CategoryId must be greater than 0.")]
         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
@@ -8,10 +8,13 @@ public class CustomerDto : ICustomer
         public string CustomerId { get; set; }
 
         [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
@@ -10,36 +10,45 @@ public class EmployeeDto : IEmployee
         public int EmployeeId { get; set; }
 
         [Required(ErrorMessage = "Last name is required.")]
+        [StringLength(50, ErrorMessage = "Last name cannot exceed 50 characters.")]
         [SwaggerSchema("Employee's last name.")]
         public string LastName { get; set; }
 
+        [StringLength(50, ErrorMessage = "First name cannot exceed 50 characters.")]
         [SwaggerSchema("Employee's first name.")]
         public string FirstName { get; set; }
 
+        [StringLength(50, ErrorMessage = "Title cannot exceed 50 characters.")]
         [SwaggerSchema("Employee's title")]
         public string Title { get; set; }
 
+        [StringLength(50, ErrorMessage = "Title of courtesy cannot exceed 50 characters.")]
         [SwaggerSchema("Title used in salutations")]
         public string TitleOfCourtesy { get; set; }
 
         [DataType(DataType.Date, ErrorMessage = "BirthDate must be a valid date.")]
+        [DisplayFormat(ApplyFormatInEditMode = true, DataFormatString = "{0:yyyy-MM-dd}")]
         [SwaggerSchema("Employee's birth date")]
         public string BirthDate { get; set; }
 
         [DataType(DataType.Date, ErrorMessage = "HireDate must be a valid date.")]
+        [DisplayFormat(ApplyFormatInEditMode = true, DataFormatString = "{0:yyyy-MM-dd}")]
         [SwaggerSchema("Employee's hire date")]
         public string HireDate { get; set; }
 
         public string AddressId { get; set; }
 
         public AddressDto Address { get; set; }
 
+        [StringLength(1000, ErrorMessage = "Notes cannot exceed 1000 characters.")]
         [SwaggerSchema("General information about employee's background.")]
         public string Notes { get; set; }
 
+        [RegularExpression(@"^https?:\/\/.+\..+", ErrorMessage = "Avatar URL is not valid.")]
         [SwaggerSchema("Employee's avatar url.")]
         public string AvatarUrl { get; set; }
 
+        [Range(1, int.MaxValue, ErrorMessage = "ReportsTo must be a valid employee ID.")]
         [SwaggerSchema("Employee's supervisor.")]
         public int ReportsTo { get; set; }
     }
diff --git a/NorthwindCRUD/Models/Dtos/OrderDetailDto.cs b/NorthwindCRUD/Models/Dtos/OrderDetailDto.cs
@@ -9,8 +9,10 @@ public class OrderDetailDto
 
         public int ProductId { get; set; }
 
+        [Range(0.01, double.MaxValue, ErrorMessage = "Unit price must be greater than 0.")]
         public double UnitPrice { get; set; }
 
+        [Range(1, int.MaxValue, ErrorMessage = "Quantity must be at least 1.")]
         public int Quantity { get; set; }
 
         public float Discount { get; set; }
diff --git a/NorthwindCRUD/Models/Dtos/OrderDto.cs b/NorthwindCRUD/Models/Dtos/OrderDto.cs
@@ -1,6 +1,6 @@
 ﻿using System.ComponentModel.DataAnnotations;
 using NorthwindCRUD.Models.Contracts;
-using NorthwindCRUD.Models.Enums;
+using static NorthwindCRUD.Helpers.Enums;
 
 namespace NorthwindCRUD.Models.Dtos
 {
@@ -9,22 +9,28 @@ public class OrderDto : IOrder
         public int OrderId { get; set; }
 
         [Required(ErrorMessage = "CustomerId is required.")]
-        public string? CustomerId { get; set; }
+        public string CustomerId { get; set; }
 
+        [Range(1, int.MaxValue, ErrorMessage = "EmployeeId must be a valid employee ID.")]
         public int EmployeeId { get; set; }
 
-        public int? ShipperId { get; set; }
+        [Range(1, int.MaxValue, ErrorMessage = "ShipperId must be a valid shipper ID.")]
+        public int ShipperId { get; set; }
 
         [DataType(DataType.Date, ErrorMessage = "OrderDate must be a valid date.")]
+        [DisplayFormat(ApplyFormatInEditMode = true, DataFormatString = "{0:yyyy-MM-dd}")]
         public string OrderDate { get; set; }
 
         [DataType(DataType.Date, ErrorMessage = "RequiredDate must be a valid date.")]
+        [DisplayFormat(ApplyFormatInEditMode = true, DataFormatString = "{0:yyyy-MM-dd}")]
         public string RequiredDate { get; set; }
 
         public Shipping? ShipVia { get; set; }
 
+        [Range(0, double.MaxValue, ErrorMessage = "Freight must be a non-negative value.")]
         public double Freight { get; set; }
 
+        [StringLength(100, ErrorMessage = "ShipName cannot exceed 100 characters.")]
         public string ShipName { get; set; }
 
         public bool Completed { get; set; }
diff --git a/NorthwindCRUD/Models/Dtos/ProductDto.cs b/NorthwindCRUD/Models/Dtos/ProductDto.cs
@@ -1,25 +1,32 @@
-﻿using NorthwindCRUD.Models.Contracts;
+﻿using System.ComponentModel.DataAnnotations;
+using NorthwindCRUD.Models.Contracts;
 
 namespace NorthwindCRUD.Models.Dtos
 {
     public class ProductDto : IProduct
     {
+        [Required(ErrorMessage = "ProductId is required.")]
         public int ProductId { get; set; }
 
-        public string ProductName { get; set; }
-
+        [Range(1, int.MaxValue, ErrorMessage = "SupplierId must be a valid supplier ID.")]
         public int? SupplierId { get; set; }
 
+        [Range(1, int.MaxValue, ErrorMessage = "CategoryId must be a valid category ID.")]
         public int? CategoryId { get; set; }
 
+        [StringLength(100, ErrorMessage = "QuantityPerUnit cannot exceed 100 characters.")]
         public string QuantityPerUnit { get; set; }
 
+        [Range(0, double.MaxValue, ErrorMessage = "UnitPrice must be a non-negative value.")]
         public double? UnitPrice { get; set; }
 
+        [Range(0, 1000000000, ErrorMessage = "UnitsInStock must be a non-negative value.")]
         public int? UnitsInStock { get; set; }
 
+        [Range(0, 1000000, ErrorMessage = "UnitsOnOrder must be a non-negative value.")]
         public int? UnitsOnOrder { get; set; }
 
+        [Range(0, int.MaxValue, ErrorMessage = "ReorderLevel must be a non-negative value.")]
         public int? ReorderLevel { get; set; }
 
         public bool Discontinued { get; set; }
diff --git a/NorthwindCRUD/Models/Dtos/SalesDto.cs b/NorthwindCRUD/Models/Dtos/SalesDto.cs
@@ -7,8 +7,10 @@ public class SalesDto
         [Required(ErrorMessage = "ProductId is required.")]
         public int ProductId { get; set; }
 
+        [Range(1, int.MaxValue, ErrorMessage = "QuantitySold must be at least 1.")]
         public int QuantitySold { get; set; }
 
+        [Range(0.01, 1000000, ErrorMessage = "SaleAmount must be greater than 0.")]
         public double SaleAmount { get; set; }
     }
 }
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
