code cleanup and updated readme

md-redwan-hossain · Nov 22, 2023 · b80a02e · b80a02e
1 parent 1dd3948
commit b80a02e
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 19 deletions.
diff --git a/Api/District/DistrictController.cs b/Api/District/DistrictController.cs
@@ -70,7 +70,7 @@ public async Task<IActionResult> GetAll(
         bool addSubDistricts = false)
     {
         var result = await _districtService.FindAll(
-            apiPagination.Page, apiPagination.Limit, sortOrder, addDivision, addSubDistricts);
+            apiPagination, sortOrder, addDivision, addSubDistricts);
 
         return Ok(result.Select(x => x.ToDto(addDivision, addSubDistricts)));
     }

diff --git a/Api/District/DistrictService.cs b/Api/District/DistrictService.cs
@@ -30,15 +30,15 @@ public DistrictService(BdGeographicalDataDbContext dbContext) =>
     }
 
     public async Task<IEnumerable<Entity.District>> FindAll(
-        ushort page, ushort limit, ApiResponseSortOrder sortOrder,
+        ApiPagination apiPagination, ApiResponseSortOrder sortOrder,
         bool addDivision, bool addSubDistricts)
     {
         var data = _dbSet.AsQueryable();
         data = IncludeRelationalData(data, addDivision, addSubDistricts);
 
         data = data
-            .Skip((page - 1) * (limit))
-            .Take(limit);
+            .Skip((apiPagination.Page - 1) * apiPagination.Limit)
+            .Take(apiPagination.Limit);
 
         if (sortOrder == ApiResponseSortOrder.Desc)
             data = data.OrderByDescending(x => x.EnglishName);
@@ -48,7 +48,7 @@ public DistrictService(BdGeographicalDataDbContext dbContext) =>
         return await data.ToListAsync();
     }
 
-    private IQueryable<Entity.District> IncludeRelationalData(
+    private static IQueryable<Entity.District> IncludeRelationalData(
         IQueryable<Entity.District> data, bool addDivision, bool addSubDistricts)
     {
         if (addDivision && addSubDistricts)

diff --git a/Api/District/IDistrictService.cs b/Api/District/IDistrictService.cs
@@ -10,6 +10,6 @@ public interface IDistrictService
         string districtName, string divisionName, bool addDivision, bool addSubDistricts);
 
     Task<IEnumerable<Entity.District>> FindAll(
-        ushort page, ushort limit, ApiResponseSortOrder sortOrder,
+        ApiPagination apiPagination, ApiResponseSortOrder sortOrder,
         bool addDivision, bool addSubDistricts);
 }
diff --git a/Api/Division/DivisionController.cs b/Api/Division/DivisionController.cs
@@ -69,7 +69,7 @@ public async Task<IActionResult> GetAll(
     )
     {
         var result = await _divisionService.FindAll(
-            apiPagination.Page, apiPagination.Limit, sortOrder, addDistricts, addSubDistricts);
+            apiPagination, sortOrder, addDistricts, addSubDistricts);
 
         return Ok(result.Select(x => x.ToDto(addDistricts, addSubDistricts)));
     }

diff --git a/Api/Division/DivisionService.cs b/Api/Division/DivisionService.cs
@@ -28,15 +28,15 @@ public DivisionService(BdGeographicalDataDbContext dbContext) =>
     }
 
     public async Task<IEnumerable<Entity.Division>> FindAll(
-        ushort page, ushort limit, ApiResponseSortOrder sortOrder,
+        ApiPagination apiPagination, ApiResponseSortOrder sortOrder,
         bool addDistricts, bool addSubDistricts)
     {
         var data = _dbSet.AsQueryable();
         data = IncludeRelationalData(data, addDistricts, addSubDistricts);
 
         data = data
-            .Skip((page - 1) * (limit))
-            .Take(limit);
+            .Skip((apiPagination.Page - 1) * apiPagination.Limit)
+            .Take(apiPagination.Limit);
 
         if (sortOrder == ApiResponseSortOrder.Desc)
             data = data.OrderByDescending(x => x.EnglishName);
@@ -47,7 +47,7 @@ public DivisionService(BdGeographicalDataDbContext dbContext) =>
     }
 
 
-    private IQueryable<Entity.Division> IncludeRelationalData(
+    private static IQueryable<Entity.Division> IncludeRelationalData(
         IQueryable<Entity.Division> data, bool addDistricts, bool addSubDistricts)
     {
         if (addDistricts && addSubDistricts)

diff --git a/Api/Division/IDivisionService.cs b/Api/Division/IDivisionService.cs
@@ -8,6 +8,6 @@ public interface IDivisionService
 
     Task<Entity.Division?> FindOneByEnglishName(string divisionName, bool addDistricts, bool addSubDistricts);
 
-    Task<IEnumerable<Entity.Division>> FindAll(ushort page, ushort limit, ApiResponseSortOrder sortOrder,
+    Task<IEnumerable<Entity.Division>> FindAll(ApiPagination apiPagination, ApiResponseSortOrder sortOrder,
         bool addDistricts, bool addSubDistricts);
 }
diff --git a/Api/SubDistrict/ISubDistrictService.cs b/Api/SubDistrict/ISubDistrictService.cs
@@ -9,6 +9,6 @@ public interface ISubDistrictService
     Task<Entity.SubDistrict?> FindOneByEnglishName(string subDistrictName, string districtName, string divisionName,
         bool addDistrict, bool addDivision);
 
-    Task<IEnumerable<Entity.SubDistrict>> FindAll(ushort page, ushort limit, ApiResponseSortOrder sortOrder,
+    Task<IEnumerable<Entity.SubDistrict>> FindAll(ApiPagination apiPagination, ApiResponseSortOrder sortOrder,
         bool addDistrict, bool addDivision);
 }
diff --git a/Api/SubDistrict/SubDistrictController.cs b/Api/SubDistrict/SubDistrictController.cs
@@ -69,8 +69,7 @@ public async Task<IActionResult> GetAll(
         [FromQuery(Name = "add_district")] bool addDistrict = false
     )
     {
-        var result = await _subDistrictService.FindAll(
-            apiPagination.Page, apiPagination.Limit, sortOrder, addDistrict, addDivision);
+        var result = await _subDistrictService.FindAll(apiPagination, sortOrder, addDistrict, addDivision);
         return Ok(result.Select(x => x.ToDto(true, true)));
     }
 }
diff --git a/Api/SubDistrict/SubDistrictService.cs b/Api/SubDistrict/SubDistrictService.cs
@@ -31,7 +31,7 @@ public SubDistrictService(BdGeographicalDataDbContext dbContext) =>
     }
 
     public async Task<IEnumerable<Entity.SubDistrict>> FindAll(
-        ushort page, ushort limit, ApiResponseSortOrder sortOrder, bool addDistrict, bool addDivision)
+        ApiPagination apiPagination, ApiResponseSortOrder sortOrder, bool addDistrict, bool addDivision)
     {
         var data = _dbSet.AsQueryable();
         data = IncludeRelationalData(data, addDistrict, addDivision);
@@ -41,8 +41,8 @@ public SubDistrictService(BdGeographicalDataDbContext dbContext) =>
             .ThenInclude(x => x.Division);
 
         data = data
-            .Skip((page - 1) * (limit))
-            .Take(limit);
+            .Skip((apiPagination.Page - 1) * apiPagination.Limit)
+            .Take(apiPagination.Limit);
 
         if (sortOrder == ApiResponseSortOrder.Desc)
             data = data.OrderByDescending(x => x.EnglishName);
@@ -53,7 +53,7 @@ public SubDistrictService(BdGeographicalDataDbContext dbContext) =>
     }
 
 
-    private IQueryable<Entity.SubDistrict> IncludeRelationalData(
+    private static IQueryable<Entity.SubDistrict> IncludeRelationalData(
         IQueryable<Entity.SubDistrict> data, bool addDistrict, bool addDivision)
     {
         if (addDistrict && addDivision)

diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ This API will provide Division, District, Sub-District related data of Banglades
 - A Districts and its Division and Sub-Districts.
 - A Sub-District and its Division and District.
 
+![Screenshot of swagger doc](api.png)
+
 ## Where to use
 
 - Data provided by this API are frequently used in web applications where Geographical data is utilized.

diff --git a/api.png b/api.png