Adding two more custom swagger attributes

zdrawku · zdrawku · commit dee63a076808 · 2024-07-02T16:08:29.000+03:00
diff --git a/NorthwindCRUD/Attributes/SwaggerParameterAttributes.cs b/NorthwindCRUD/Attributes/SwaggerParameterAttributes.cs
@@ -25,4 +25,20 @@ public SwaggerOrderByParameterAttribute()
             {
             }
         }
+
+        public class SwaggerSkipParameterAttribute : SwaggerParameterAttribute
+        {
+            public SwaggerSkipParameterAttribute()
+                : base("The number of records to skip before starting to fetch them. If this parameter is not provided, fetching starts from the beginning.")
+            {
+            }
+        }
+
+        public class SwaggerTopParameterAttribute : SwaggerParameterAttribute
+        {
+            public SwaggerTopParameterAttribute()
+                : base("The maximum number of records to fetch. If this parameter is not provided, all records are fetched.")
+            {
+            }
+        }
 }
diff --git a/NorthwindCRUD/Controllers/CategoriesController.cs b/NorthwindCRUD/Controllers/CategoriesController.cs
@@ -51,9 +51,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch them. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of records to fetch. If this parameter is not provided, all records are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the records by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
diff --git a/NorthwindCRUD/Controllers/CustomersController.cs b/NorthwindCRUD/Controllers/CustomersController.cs
@@ -51,9 +51,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch them. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of records to fetch. If this parameter is not provided, all records are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the records by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
diff --git a/NorthwindCRUD/Controllers/EmployeesController.cs b/NorthwindCRUD/Controllers/EmployeesController.cs
@@ -53,9 +53,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch the employees. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of employees to fetch. If this parameter is not provided, all employees are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the employees by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
diff --git a/NorthwindCRUD/Controllers/OrdersController.cs b/NorthwindCRUD/Controllers/OrdersController.cs
@@ -58,9 +58,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch the orders. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of orders to fetch. If this parameter is not provided, all orders are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the orders by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
diff --git a/NorthwindCRUD/Controllers/ProductsController.cs b/NorthwindCRUD/Controllers/ProductsController.cs
@@ -57,9 +57,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch the products. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of products to fetch. If this parameter is not provided, all products are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the products by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
diff --git a/NorthwindCRUD/Controllers/RegionsController.cs b/NorthwindCRUD/Controllers/RegionsController.cs
@@ -52,9 +52,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch the regions. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of regions to fetch. If this parameter is not provided, all regions are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the regions by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
diff --git a/NorthwindCRUD/Controllers/ShippersController.cs b/NorthwindCRUD/Controllers/ShippersController.cs
@@ -52,9 +52,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch the shippers. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of shippers to fetch. If this parameter is not provided, all shippers are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the shippers by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
@@ -92,7 +92,7 @@ public ActionResult<PagedResultDto<ShipperDto>> GetPagedShippersWithPage(
                 var shippers = this.shipperService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.FetchPagedData<RegionDb, RegionDto>(shippers, null, null, pageIndex, size, orderBy);
+                var pagedResult = pagingService.FetchPagedData<ShipperDb, ShipperDto>(shippers, null, null, pageIndex, size, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/SuppliersController.cs b/NorthwindCRUD/Controllers/SuppliersController.cs
@@ -52,9 +52,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch the suppliers. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of suppliers to fetch. If this parameter is not provided, all suppliers are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the suppliers by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
diff --git a/NorthwindCRUD/Controllers/TerritoriesController.cs b/NorthwindCRUD/Controllers/TerritoriesController.cs
@@ -54,9 +54,9 @@ 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][SwaggerParameter("The number of records to skip before starting to fetch the territories. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
-            [FromQuery][SwaggerParameter("The maximum number of territories to fetch. If this parameter is not provided, all territories are fetched.")] int? top,
-            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the territories by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
diff --git a/NorthwindCRUD/Services/PagingService.cs b/NorthwindCRUD/Services/PagingService.cs
@@ -14,7 +14,7 @@ PagedResultDto<TDto> FetchPagedData<TEntity, TDto>(
             IQueryable<TEntity> query,
             int? skip = null,
             int? top = null,
-            int? page = null,
+            int? pageIndex = null,
             int? size = null,
             string? orderBy = null);
     }

Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,20 @@ public SwaggerOrderByParameterAttribute()`
`25`	`25`	`{`
`26`	`26`	`}`
`27`	`27`	`}`
	`28`	`+`
	`29`	`+ public class SwaggerSkipParameterAttribute : SwaggerParameterAttribute`
	`30`	`+ {`
	`31`	`+ public SwaggerSkipParameterAttribute()`
	`32`	`+ : base("The number of records to skip before starting to fetch them. If this parameter is not provided, fetching starts from the beginning.")`
	`33`	`+ {`
	`34`	`+ }`
	`35`	`+ }`
	`36`	`+`
	`37`	`+ public class SwaggerTopParameterAttribute : SwaggerParameterAttribute`
	`38`	`+ {`
	`39`	`+ public SwaggerTopParameterAttribute()`
	`40`	`+ : base("The maximum number of records to fetch. If this parameter is not provided, all records are fetched.")`
	`41`	`+ {`
	`42`	`+ }`
	`43`	`+ }`
`28`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,9 +51,9 @@ public ActionResult<CategoryDto[]> GetAll()`
`51`	`51`	`/// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>`
`52`	`52`	`[HttpGet("GetCategoriesWithSkip")]`
`53`	`53`	`public ActionResult<PagedResultDto<CategoryDto>> GetCategoriesWithSkip(`
`54`		`- [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch them. If this parameter is not provided, fetching starts from the beginning.")] int? skip,`
`55`		`- [FromQuery][SwaggerParameter("The maximum number of records to fetch. If this parameter is not provided, all records are fetched.")] int? top,`
`56`		`- [FromQuery][SwaggerParameter("A comma-separated list of fields to order the records by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)`
	`54`	`+ [FromQuery][Attributes.SwaggerSkipParameter] int? skip,`
	`55`	`+ [FromQuery][Attributes.SwaggerTopParameter] int? top,`
	`56`	`+ [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)`
`57`	`57`	`{`
`58`	`58`	`try`
`59`	`59`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,9 +53,9 @@ public ActionResult<EmployeeDto[]> GetAll()`
`53`	`53`	`/// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>`
`54`	`54`	`[HttpGet("GetEmployeesWithSkip")]`
`55`	`55`	`public ActionResult<PagedResultDto<EmployeeDto>> GetPagedEmployees(`
`56`		`- [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch the employees. If this parameter is not provided, fetching starts from the beginning.")] int? skip,`
`57`		`- [FromQuery][SwaggerParameter("The maximum number of employees to fetch. If this parameter is not provided, all employees are fetched.")] int? top,`
`58`		`- [FromQuery][SwaggerParameter("A comma-separated list of fields to order the employees by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)`
	`56`	`+ [FromQuery][Attributes.SwaggerSkipParameter] int? skip,`
	`57`	`+ [FromQuery][Attributes.SwaggerTopParameter] int? top,`
	`58`	`+ [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)`
`59`	`59`	`{`
`60`	`60`	`try`
`61`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -58,9 +58,9 @@ public ActionResult<OrderDto[]> GetAll()`
`58`	`58`	`/// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>`
`59`	`59`	`[HttpGet("GetPagedOrders")]`
`60`	`60`	`public ActionResult<PagedResultDto<OrderDto>> GetAllOrders(`
`61`		`- [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch the orders. If this parameter is not provided, fetching starts from the beginning.")] int? skip,`
`62`		`- [FromQuery][SwaggerParameter("The maximum number of orders to fetch. If this parameter is not provided, all orders are fetched.")] int? top,`
`63`		`- [FromQuery][SwaggerParameter("A comma-separated list of fields to order the orders by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)`
	`61`	`+ [FromQuery][Attributes.SwaggerSkipParameter] int? skip,`
	`62`	`+ [FromQuery][Attributes.SwaggerTopParameter] int? top,`
	`63`	`+ [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)`
`64`	`64`	`{`
`65`	`65`	`try`
`66`	`66`	`{`
Original file line number	Diff line number	Diff line change
`@@ -57,9 +57,9 @@ public ActionResult<ProductDto[]> GetAll()`
`57`	`57`	`/// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>`
`58`	`58`	`[HttpGet("GetPagedProducts")]`
`59`	`59`	`public ActionResult<PagedResultDto<ProductDto>> GetAllProducts(`
`60`		`- [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch the products. If this parameter is not provided, fetching starts from the beginning.")] int? skip,`
`61`		`- [FromQuery][SwaggerParameter("The maximum number of products to fetch. If this parameter is not provided, all products are fetched.")] int? top,`
`62`		`- [FromQuery][SwaggerParameter("A comma-separated list of fields to order the products by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)`
	`60`	`+ [FromQuery][Attributes.SwaggerSkipParameter] int? skip,`
	`61`	`+ [FromQuery][Attributes.SwaggerTopParameter] int? top,`
	`62`	`+ [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)`
`63`	`63`	`{`
`64`	`64`	`try`
`65`	`65`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,9 @@ public ActionResult<RegionDto[]> GetAll()`
`52`	`52`	`/// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>`
`53`	`53`	`[HttpGet("GetPagedRegions")]`
`54`	`54`	`public ActionResult<PagedResultDto<RegionDto>> GetAllRegions(`
`55`		`- [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch the regions. If this parameter is not provided, fetching starts from the beginning.")] int? skip,`
`56`		`- [FromQuery][SwaggerParameter("The maximum number of regions to fetch. If this parameter is not provided, all regions are fetched.")] int? top,`
`57`		`- [FromQuery][SwaggerParameter("A comma-separated list of fields to order the regions by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)`
	`55`	`+ [FromQuery][Attributes.SwaggerSkipParameter] int? skip,`
	`56`	`+ [FromQuery][Attributes.SwaggerTopParameter] int? top,`
	`57`	`+ [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)`
`58`	`58`	`{`
`59`	`59`	`try`
`60`	`60`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,9 @@ public ActionResult<ShipperDto[]> GetAll()`
`52`	`52`	`/// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>`
`53`	`53`	`[HttpGet("GetPagedShippersWithSkip")]`
`54`	`54`	`public ActionResult<PagedResultDto<ShipperDto>> GetPagedShippersWithSkip(`
`55`		`- [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch the shippers. If this parameter is not provided, fetching starts from the beginning.")] int? skip,`
`56`		`- [FromQuery][SwaggerParameter("The maximum number of shippers to fetch. If this parameter is not provided, all shippers are fetched.")] int? top,`
`57`		`- [FromQuery][SwaggerParameter("A comma-separated list of fields to order the shippers by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)`
	`55`	`+ [FromQuery][Attributes.SwaggerSkipParameter] int? skip,`
	`56`	`+ [FromQuery][Attributes.SwaggerTopParameter] int? top,`
	`57`	`+ [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)`
`58`	`58`	`{`
`59`	`59`	`try`
`60`	`60`	`{`
`@@ -92,7 +92,7 @@ public ActionResult<PagedResultDto<ShipperDto>> GetPagedShippersWithPage(`
`92`	`92`	`var shippers = this.shipperService.GetAllAsQueryable();`
`93`	`93`
`94`	`94`	`// Get paged data`
`95`		`- var pagedResult = pagingService.FetchPagedData<RegionDb, RegionDto>(shippers, null, null, pageIndex, size, orderBy);`
	`95`	`+ var pagedResult = pagingService.FetchPagedData<ShipperDb, ShipperDto>(shippers, null, null, pageIndex, size, orderBy);`
`96`	`96`
`97`	`97`	`return Ok(pagedResult);`
`98`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,9 +54,9 @@ public ActionResult<TerritoryDto[]> GetAll()`
`54`	`54`	`/// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>`
`55`	`55`	`[HttpGet("GetPagedTerritories")]`
`56`	`56`	`public ActionResult<PagedResultDto<TerritoryDto>> GetAllTerritories(`
`57`		`- [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch the territories. If this parameter is not provided, fetching starts from the beginning.")] int? skip,`
`58`		`- [FromQuery][SwaggerParameter("The maximum number of territories to fetch. If this parameter is not provided, all territories are fetched.")] int? top,`
`59`		`- [FromQuery][SwaggerParameter("A comma-separated list of fields to order the territories by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] string? orderBy)`
	`57`	`+ [FromQuery][Attributes.SwaggerSkipParameter] int? skip,`
	`58`	`+ [FromQuery][Attributes.SwaggerTopParameter] int? top,`
	`59`	`+ [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)`
`60`	`60`	`{`
`61`	`61`	`try`
`62`	`62`	`{`