Merge pull request #33 from IgniteUI/add-remote-paging-capabilities

Update remote paging endpoint

Author: zdrawku

NorthwindCRUD/Attributes/SwaggerParameterAttributes.cs

@@ -0,0 +1,44 @@
+using Swashbuckle.AspNetCore.Annotations;
+
+namespace NorthwindCRUD.Attributes
+{
+        public class SwaggerPageParameterAttribute : SwaggerParameterAttribute
+        {
+            public SwaggerPageParameterAttribute()
+                : base("The page index of records to fetch. If this parameter is not provided, fetching starts from the beginning (page 0).")
+            {
+            }
+        }
+
+        public class SwaggerSizeParameterAttribute : SwaggerParameterAttribute
+        {
+            public SwaggerSizeParameterAttribute()
+                : base("The maximum number of records to fetch per page. If this parameter is not provided, all records are fetched.")
+            {
+            }
+        }
+
+        public class SwaggerOrderByParameterAttribute : SwaggerParameterAttribute
+        {
+            public SwaggerOrderByParameterAttribute()
+                : base("A comma-separated list of fields to order the records by, along with the sort direction (e.g., 'field1 asc, field2 desc').")
+            {
+            }
+        }
+
+        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.")
+            {
+            }
+        }
+}

NorthwindCRUD/Controllers/CategoriesController.cs

@@ -6,6 +6,7 @@ namespace NorthwindCRUD.Controllers
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -48,16 +49,19 @@ public ActionResult<CategoryDto[]> GetAll()
         /// <param name="top">The maximum number of categories to fetch. If this parameter is not provided, all categories are fetched.</param>
         /// <param name="orderBy">A comma-separated list of fields to order the categories by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
-        [HttpGet("GetPagedCategories")]
-        public ActionResult<PagedResultDto<ProductDto>> GetPagedCategories(int? skip, int? top, string? orderBy)
+        [HttpGet("GetCategoriesWithSkip")]
+        public ActionResult<PagedResultDto<CategoryDto>> GetCategoriesWithSkip(
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
-                // Retrieve all categories
-                var categories = this.categoryService.GetAll();
+                // Retrieve categories as Queryable
+                var categories = this.categoryService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<CategoryDb, CategoryDto>(categories, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedData<CategoryDb, CategoryDto>(categories, skip, top, null, null, orderBy);
 
                 return Ok(pagedResult);
             }
@@ -68,6 +72,55 @@ public ActionResult<PagedResultDto<ProductDto>> GetPagedCategories(int? skip, in
             }
         }
 
+        /// <summary>
+        /// Fetches all categories or a page of categories based on the provided parameters.
+        /// </summary>
+        /// <param name="pageIndex">The page index of records to fetch. If this parameter is not provided, fetching starts from the beginning (page 0).</param>
+        /// <param name="size">The maximum number of records to fetch per page. If this parameter is not provided, all records are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the records by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetCategoriesWithPage")]
+        public ActionResult<PagedResultDto<CategoryDto>> GetCategoriesWithPage(
+            [FromQuery][Attributes.SwaggerPageParameter] int? pageIndex,
+            [FromQuery][Attributes.SwaggerSizeParameter] int? size,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
+        {
+            try
+            {
+                // Retrieve categories as Queryable
+                var categories = this.categoryService.GetAllAsQueryable();
+
+                // Get paged data
+                var pagedResult = pagingService.FetchPagedData<CategoryDb, CategoryDto>(categories, null, null, pageIndex, size, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
+        /// <summary>
+        /// Retrieves the total number of categories.
+        /// </summary>
+        /// <returns>Total count of categories as an integer.</returns>
+        [HttpGet("GetCategoriesCount")]
+        public ActionResult<CountResultDto> GetCategoriesCount()
+        {
+            try
+            {
+                var count = categoryService.GetAllAsQueryable().Count();
+                return new CountResultDto() { Count = count };
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<CategoryDto> GetById(int id)
         {

NorthwindCRUD/Controllers/CustomersController.cs

@@ -6,6 +6,7 @@
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -48,16 +49,19 @@ public ActionResult<CustomerDto[]> GetAll()
         /// <param name="top">The maximum number of customers to fetch. If this parameter is not provided, all customers are fetched.</param>
         /// <param name="orderBy">A comma-separated list of fields to order the customers by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
-        [HttpGet("GetPagedCustomers")]
-        public ActionResult<PagedResultDto<CustomerDto>> GetAllCustomers(int? skip, int? top, string? orderBy)
+        [HttpGet("GetCustomersWithSkip")]
+        public ActionResult<PagedResultDto<CustomerDto>> GetCustomersWithSkip(
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
                 // Retrieve all customers
-                var customers = this.customerService.GetAll();
+                var customers = this.customerService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<CustomerDb, CustomerDto>(customers, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedData<CustomerDb, CustomerDto>(customers, skip, top, null, null, orderBy);
 
                 return Ok(pagedResult);
             }
@@ -68,6 +72,55 @@ public ActionResult<PagedResultDto<CustomerDto>> GetAllCustomers(int? skip, int?
             }
         }
 
+        /// <summary>
+        /// Fetches all customers or a page of customers based on the provided parameters.
+        /// </summary>
+        /// <param name="pageIndex">The page index of records to fetch. If this parameter is not provided, fetching starts from the beginning (page 0).</param>
+        /// <param name="size">The maximum number of records to fetch per page. If this parameter is not provided, all records are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the records by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetCustomersWithPage")]
+        public ActionResult<PagedResultDto<CustomerDto>> GetCustomersWithPage(
+            [FromQuery][Attributes.SwaggerPageParameter] int? pageIndex,
+            [FromQuery][Attributes.SwaggerSizeParameter] int? size,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
+        {
+            try
+            {
+                // Retrieve customers as Queryable
+                var customers = this.customerService.GetAllAsQueryable();
+
+                // Get paged data
+                var pagedResult = pagingService.FetchPagedData<CustomerDb, CustomerDto>(customers, null, null, pageIndex, size, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
+        /// <summary>
+        /// Retrieves the total number of customers.
+        /// </summary>
+        /// <returns>Total count of customers as an integer.</returns>
+        [HttpGet("GetCustomersCount")]
+        public ActionResult<CountResultDto> GetCustomersCount()
+        {
+            try
+            {
+                var count = customerService.GetAllAsQueryable().Count();
+                return new CountResultDto() { Count = count };
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<CustomerDto> GetById(string id)
         {

NorthwindCRUD/Controllers/EmployeesController.cs

@@ -6,6 +6,7 @@
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -50,16 +51,19 @@ public ActionResult<EmployeeDto[]> GetAll()
         /// <param name="top">The maximum number of employees to fetch. If this parameter is not provided, all employees are fetched.</param>
         /// <param name="orderBy">A comma-separated list of fields to order the employees by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
-        [HttpGet("GetPagedEmployees")]
-        public ActionResult<PagedResultDto<EmployeeDto>> GetAllEmployees(int? skip, int? top, string? orderBy)
+        [HttpGet("GetEmployeesWithSkip")]
+        public ActionResult<PagedResultDto<EmployeeDto>> GetPagedEmployees(
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
-                // Retrieve all employees
-                var employees = this.employeeService.GetAll();
+                // Retrieve all employees as Queryable
+                var employees = this.employeeService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<EmployeeDb, EmployeeDto>(employees, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedData<EmployeeDb, EmployeeDto>(employees, skip, top, null, null, orderBy);
 
                 return Ok(pagedResult);
             }
@@ -70,6 +74,55 @@ public ActionResult<PagedResultDto<EmployeeDto>> GetAllEmployees(int? skip, int?
             }
         }
 
+        /// <summary>
+        /// Fetches all employees or a page of employees based on the provided parameters.
+        /// </summary>
+        /// <param name="pageIndex">The page index of records to fetch. If this parameter is not provided, fetching starts from the beginning (page 0).</param>
+        /// <param name="size">The maximum number of records to fetch per page. If this parameter is not provided, all records are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the records by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedEmployeesWithPage")]
+        public ActionResult<PagedResultDto<EmployeeDto>> GetPagedEmployeesWithPage(
+            [FromQuery][Attributes.SwaggerPageParameter] int? pageIndex,
+            [FromQuery][Attributes.SwaggerSizeParameter] int? size,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
+        {
+            try
+            {
+                // Retrieve employees as Queryable
+                var employees = this.employeeService.GetAllAsQueryable();
+
+                // Get paged data
+                var pagedResult = pagingService.FetchPagedData<EmployeeDb, EmployeeDto>(employees, null, null, pageIndex, size, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
+        /// <summary>
+        /// Retrieves the total number of employees.
+        /// </summary>
+        /// <returns>Total count of employees as an integer.</returns>
+        [HttpGet("GetEmployeesCount")]
+        public ActionResult<CountResultDto> GetEmployeesCount()
+        {
+            try
+            {
+                var count = employeeService.GetAllAsQueryable().Count();
+                return new CountResultDto() { Count = count };
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<EmployeeDto> GetById(int id)
         {

NorthwindCRUD/Controllers/OrdersController.cs

@@ -5,7 +5,6 @@
     using Microsoft.AspNetCore.Mvc;
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
-    using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
 
     [ApiController]
@@ -56,15 +55,18 @@ public ActionResult<OrderDto[]> GetAll()
         /// <param name="orderBy">A comma-separated list of fields to order the orders by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
         /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
         [HttpGet("GetPagedOrders")]
-        public ActionResult<PagedResultDto<OrderDto>> GetAllOrders(int? skip, int? top, string? orderBy)
+        public ActionResult<PagedResultDto<OrderDto>> GetAllOrders(
+            [FromQuery][Attributes.SwaggerSkipParameter] int? skip,
+            [FromQuery][Attributes.SwaggerTopParameter] int? top,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
         {
             try
             {
                 // Retrieve all orders
-                var orders = this.orderService.GetAll();
+                var orders = this.orderService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<OrderDb, OrderDto>(orders, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedData<OrderDb, OrderDto>(orders, skip, top, null, null, orderBy);
 
                 return Ok(pagedResult);
             }
@@ -75,6 +77,55 @@ public ActionResult<PagedResultDto<OrderDto>> GetAllOrders(int? skip, int? top,
             }
         }
 
+        /// <summary>
+        /// Fetches all orders or a page of orders based on the provided parameters.
+        /// </summary>
+        /// <param name="pageIndex">The page index of records to fetch. If this parameter is not provided, fetching starts from the beginning (page 0).</param>
+        /// <param name="size">The maximum number of records to fetch per page. If this parameter is not provided, all records are fetched.</param>
+        /// <param name="orderBy">A comma-separated list of fields to order the records by, along with the sort direction (e.g., "field1 asc, field2 desc").</param>
+        /// <returns>A PagedResultDto object containing the fetched T and the total record count.</returns>
+        [HttpGet("GetPagedOrdersWithPage")]
+        public ActionResult<PagedResultDto<OrderDto>> GetPagedOrdersWithPage(
+            [FromQuery][Attributes.SwaggerPageParameter] int? pageIndex,
+            [FromQuery][Attributes.SwaggerSizeParameter] int? size,
+            [FromQuery][Attributes.SwaggerOrderByParameter] string? orderBy)
+        {
+            try
+            {
+                // Retrieve orders as Queryable
+                var orders = this.orderService.GetAllAsQueryable();
+
+                // Get paged data
+                var pagedResult = pagingService.FetchPagedData<OrderDb, OrderDto>(orders, null, null, pageIndex, size, orderBy);
+
+                return Ok(pagedResult);
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
+        /// <summary>
+        /// Retrieves the total number of orders.
+        /// </summary>
+        /// <returns>Total count of orders as an integer.</returns>
+        [HttpGet("GetOrdersCount")]
+        public ActionResult<CountResultDto> GetOrdersCount()
+        {
+            try
+            {
+                var count = orderService.GetAllAsQueryable().Count();
+                return new CountResultDto() { Count = count };
+            }
+            catch (Exception error)
+            {
+                logger.LogError(error.Message);
+                return StatusCode(500);
+            }
+        }
+
         [HttpGet("{id}")]
         public ActionResult<OrderDto> GetById(int id)
         {