Code improvements and param descriptions

zdrawku · zdrawku · commit 9869f8575e61 · 2024-07-02T11:04:21.000+03:00
diff --git a/NorthwindCRUD/Controllers/CategoriesController.cs b/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]")]
@@ -49,15 +50,18 @@ public ActionResult<CategoryDto[]> GetAll()
         /// <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)
+        public ActionResult<PagedResultDto<ProductDto>> GetPagedCategories(
+            [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch the categories. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
+            [FromQuery][SwaggerParameter("The maximum number of categories to fetch. If this parameter is not provided, all categories are fetched.")] int? top,
+            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the categories by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] 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.FetchPagedDataWithSkip<CategoryDb, CategoryDto>(categories, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/CustomersController.cs b/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]")]
@@ -49,15 +50,18 @@ public ActionResult<CustomerDto[]> GetAll()
         /// <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)
+        public ActionResult<PagedResultDto<CustomerDto>> GetAllCustomers(
+            [FromQuery][SwaggerParameter("The number of records to skip before starting to fetch the customers. If this parameter is not provided, fetching starts from the beginning.")] int? skip,
+            [FromQuery][SwaggerParameter("The maximum number of customers to fetch. If this parameter is not provided, all customers are fetched.")] int? top,
+            [FromQuery][SwaggerParameter("A comma-separated list of fields to order the customers by, along with the sort direction (e.g., 'field1 asc, field2 desc').")] 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.FetchPagedDataWithSkip<CustomerDb, CustomerDto>(customers, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/EmployeesController.cs b/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]")]
@@ -51,15 +52,18 @@ public ActionResult<EmployeeDto[]> GetAll()
         /// <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)
+        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)
         {
             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.FetchPagedDataWithSkip<EmployeeDb, EmployeeDto>(employees, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/OrdersController.cs b/NorthwindCRUD/Controllers/OrdersController.cs
@@ -7,6 +7,7 @@
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -56,15 +57,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][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)
         {
             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.FetchPagedDataWithSkip<OrderDb, OrderDto>(orders, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/ProductsController.cs b/NorthwindCRUD/Controllers/ProductsController.cs
@@ -8,6 +8,7 @@ namespace NorthwindCRUD.Controllers
     using NorthwindCRUD.Models.DbModels;
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -55,15 +56,18 @@ public ActionResult<ProductDto[]> GetAll()
         /// <param name="orderBy">A comma-separated list of fields to order the products 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("GetPagedProducts")]
-        public ActionResult<PagedResultDto<ProductDto>> GetAllProducts(int? skip, int? top, string? orderBy)
+        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)
         {
             try
             {
                 // Retrieve all products
-                var products = this.productService.GetAll();
+                var products = this.productService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<ProductDb, ProductDto>(products, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedDataWithSkip<ProductDb, ProductDto>(products, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/RegionsController.cs b/NorthwindCRUD/Controllers/RegionsController.cs
@@ -7,6 +7,7 @@
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -50,15 +51,18 @@ public ActionResult<RegionDto[]> GetAll()
         /// <param name="orderBy">A comma-separated list of fields to order the regions 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("GetPagedRegions")]
-        public ActionResult<PagedResultDto<RegionDto>> GetAllRegions(int? skip, int? top, string? orderBy)
+        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)
         {
             try
             {
                 // Retrieve all regions
-                var regions = this.regionService.GetAll();
+                var regions = this.regionService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<RegionDb, RegionDto>(regions, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedDataWithSkip<RegionDb, RegionDto>(regions, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/ShippersController.cs b/NorthwindCRUD/Controllers/ShippersController.cs
@@ -7,6 +7,7 @@
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -50,15 +51,18 @@ public ActionResult<ShipperDto[]> GetAll()
         /// <param name="orderBy">A comma-separated list of fields to order the shippers 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("GetPagedShippers")]
-        public ActionResult<PagedResultDto<ShipperDto>> GetAllShippers(int? skip, int? top, string? orderBy)
+        public ActionResult<PagedResultDto<ShipperDto>> GetAllShippers(
+            [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)
         {
             try
             {
                 // Retrieve all shippers
-                var shippers = this.shipperService.GetAll();
+                var shippers = this.shipperService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<ShipperDb, ShipperDto>(shippers, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedDataWithSkip<ShipperDb, ShipperDto>(shippers, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/SuppliersController.cs b/NorthwindCRUD/Controllers/SuppliersController.cs
@@ -7,6 +7,7 @@
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -50,15 +51,18 @@ public ActionResult<SupplierDto[]> GetAll()
         /// <param name="orderBy">A comma-separated list of fields to order the suppliers 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("GetPagedSuppliers")]
-        public ActionResult<PagedResultDto<SupplierDto>> GetAllSuppliers(int? skip, int? top, string? orderBy)
+        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)
         {
             try
             {
                 // Retrieve all suppliers
-                var suppliers = this.supplierService.GetAll();
+                var suppliers = this.supplierService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<SupplierDb, SupplierDto>(suppliers, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedDataWithSkip<SupplierDb, SupplierDto>(suppliers, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Controllers/TerritoriesController.cs b/NorthwindCRUD/Controllers/TerritoriesController.cs
@@ -7,6 +7,7 @@
     using NorthwindCRUD.Models.Dtos;
     using NorthwindCRUD.Models.InputModels;
     using NorthwindCRUD.Services;
+    using Swashbuckle.AspNetCore.Annotations;
 
     [ApiController]
     [Route("[controller]")]
@@ -52,15 +53,18 @@ public ActionResult<TerritoryDto[]> GetAll()
         /// <param name="orderBy">A comma-separated list of fields to order the territories 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("GetPagedTerritories")]
-        public ActionResult<PagedResultDto<TerritoryDto>> GetAllTerritories(int? skip, int? top, string? orderBy)
+        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)
         {
             try
             {
                 // Retrieve all territories
-                var territories = this.territoryService.GetAll();
+                var territories = this.territoryService.GetAllAsQueryable();
 
                 // Get paged data
-                var pagedResult = pagingService.GetPagedData<TerritoryDb, TerritoryDto>(territories, skip, top, orderBy);
+                var pagedResult = pagingService.FetchPagedDataWithSkip<TerritoryDb, TerritoryDto>(territories, skip, top, orderBy);
 
                 return Ok(pagedResult);
             }
diff --git a/NorthwindCRUD/Services/CategoryService.cs b/NorthwindCRUD/Services/CategoryService.cs
@@ -1,5 +1,6 @@
 ﻿namespace NorthwindCRUD.Services
 {
+    using Microsoft.EntityFrameworkCore;
     using NorthwindCRUD.Helpers;
     using NorthwindCRUD.Models.DbModels;
 
@@ -17,6 +18,11 @@ public CategoryDb[] GetAll()
             return this.dataContext.Categories.ToArray();
         }
 
+        public IQueryable<CategoryDb> GetAllAsQueryable()
+        {
+            return this.dataContext.Categories.AsQueryable();
+        }
+
         public CategoryDb? GetById(int id)
         {
             return this.dataContext.Categories.FirstOrDefault(c => c.CategoryId == id);
diff --git a/NorthwindCRUD/Services/CustomerService.cs b/NorthwindCRUD/Services/CustomerService.cs
@@ -20,6 +20,11 @@ public CustomerDb[] GetAll()
                 .ToArray();
         }
 
+        public IQueryable<CustomerDb> GetAllAsQueryable()
+        {
+            return this.dataContext.Customers.AsQueryable();
+        }
+
         public CustomerDb? GetById(string id)
         {
             return this.dataContext.Customers
diff --git a/NorthwindCRUD/Services/EmployeeService.cs b/NorthwindCRUD/Services/EmployeeService.cs
@@ -20,6 +20,11 @@ public EmployeeDb[] GetAll()
                 .ToArray();
         }
 
+        public IQueryable<EmployeeDb> GetAllAsQueryable()
+        {
+            return this.dataContext.Employees.AsQueryable();
+        }
+
         public EmployeeDb? GetById(int id)
         {
             return this.dataContext.Employees.FirstOrDefault(c => c.EmployeeId == id);
diff --git a/NorthwindCRUD/Services/OrderService.cs b/NorthwindCRUD/Services/OrderService.cs
@@ -23,6 +23,11 @@ public OrderDb[] GetAll()
                 .ToArray();
         }
 
+        public IQueryable<OrderDb> GetAllAsQueryable()
+        {
+            return this.dataContext.Orders.AsQueryable();
+        }
+
         public OrderDb[] GetNOrders(int numberOfOrdersToRetrieve)
         {
             return this.dataContext.Orders
diff --git a/NorthwindCRUD/Services/PagingService.cs b/NorthwindCRUD/Services/PagingService.cs
diff --git a/NorthwindCRUD/Services/ProductService.cs b/NorthwindCRUD/Services/ProductService.cs
diff --git a/NorthwindCRUD/Services/RegionService.cs b/NorthwindCRUD/Services/RegionService.cs
diff --git a/NorthwindCRUD/Services/ShipperService.cs b/NorthwindCRUD/Services/ShipperService.cs
diff --git a/NorthwindCRUD/Services/SupplierService.cs b/NorthwindCRUD/Services/SupplierService.cs
diff --git a/NorthwindCRUD/Services/TerritoryService.cs b/NorthwindCRUD/Services/TerritoryService.cs

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`namespace NorthwindCRUD.Services`
`2`	`2`	`{`
	`3`	`+ using Microsoft.EntityFrameworkCore;`
`3`	`4`	`using NorthwindCRUD.Helpers;`
`4`	`5`	`using NorthwindCRUD.Models.DbModels;`
`5`	`6`
`@@ -17,6 +18,11 @@ public CategoryDb[] GetAll()`
`17`	`18`	`return this.dataContext.Categories.ToArray();`
`18`	`19`	`}`
`19`	`20`
	`21`	`+ public IQueryable<CategoryDb> GetAllAsQueryable()`
	`22`	`+ {`
	`23`	`+ return this.dataContext.Categories.AsQueryable();`
	`24`	`+ }`
	`25`	`+`
`20`	`26`	`public CategoryDb? GetById(int id)`
`21`	`27`	`{`
`22`	`28`	`return this.dataContext.Categories.FirstOrDefault(c => c.CategoryId == id);`