changes to improve pagedlist and ading new endpoints for naturalareas

Mteheran · Mteheran · Mar 19, 2023 · Mar 19, 2023 · Mar 19, 2023 · 83048db054f71393bb8ce517d97da13a111df8d5
commit 83048db054f71393bb8ce517d97da13a111df8d5
diff --git a/api/DBContext.cs b/api/DBContext.cs
@@ -13,7 +13,10 @@ public class DBContext : DbContext
     public DbSet<CategoryNaturalArea> CategoryNaturalAreas { get; set; }
     public DbSet<NaturalArea> NaturalAreas { get; set; }
 
-    public DBContext(DbContextOptions<DBContext> options) : base(options) { }
+    public DBContext(DbContextOptions<DBContext> options) : base(options)
+    {
+        ChangeTracker.QueryTrackingBehavior = QueryTrackingBehavior.NoTracking;
+    }
 
     protected override void OnModelCreating(ModelBuilder builder)
     {

diff --git a/api/Program.cs b/api/Program.cs
@@ -15,7 +15,7 @@
     options.SwaggerDoc("v1", new OpenApiInfo
     {
         Version = "1.0.1",
-        Title = "API Colombia ",
+        Title = "API Colombia",
         Description = "Open and free API that contains general information about Colombia",
         TermsOfService = new Uri("https://github.com/Mteheran/api-colombia"),
         Contact = new OpenApiContact
@@ -39,7 +39,8 @@
 
 builder.Configuration.AddEnvironmentVariables();
 
-builder.Services.AddNpgsql<DBContext>(builder.Configuration.GetConnectionString("DefaultConnection"));
+builder.Services.AddNpgsql<DBContext>(
+    builder.Configuration.GetConnectionString("DefaultConnection"));
 
 builder.Services.Configure<JsonOptions>(options =>
 {

diff --git a/api/Routes/CategoryNaturalAreaRoutes.cs b/api/Routes/CategoryNaturalAreaRoutes.cs
@@ -41,6 +41,29 @@ public static void RegisterCategoryNaturalAreaAPI(WebApplication app)
           .WithMetadata(new SwaggerOperationAttribute(
               summary: CategoryNaturalAreaEndpoint.MESSAGE_BYID_SUMMARY,
               description: CategoryNaturalAreaEndpoint.MESSAGE_BYID_DESCRIPTION));
+
+            app.MapGet($"{API_CATEGORY_ROUTE_COMPLETE}/{{id}}/NaturalAreas", async (int id, DBContext db) =>
+            {
+                if (id <= 0)
+                {
+                    return Results.BadRequest();
+                }
+
+                var region = await db.CategoryNaturalAreas
+                .Include(p=> p.NaturalAreas)
+                .ThenInclude(p=> p.Department)
+                .SingleOrDefaultAsync(p => p.Id == id);
+
+                if (region is null)
+                {
+                    return Results.NotFound();
+                }
+
+                return Results.Ok(region);
+            })
+         .WithMetadata(new SwaggerOperationAttribute(
+             summary: CategoryNaturalAreaEndpoint.MESSAGE_BYID_SUMMARY,
+             description: CategoryNaturalAreaEndpoint.MESSAGE_BYID_DESCRIPTION));
         }
     }
 }

diff --git a/api/Routes/CityRoutes.cs b/api/Routes/CityRoutes.cs
@@ -79,7 +79,7 @@ public static void RegisterCityAPI(WebApplication app)
 
 
             app.MapGet($"{API_CITY_ROUTE_COMPLETE}/pagedList",
-                    async (PaginationModel pagination, DBContext db) =>
+                    async ([AsParameters] PaginationModel pagination, DBContext db) =>
             {
 
                 if (pagination.Page<= 0 || pagination.PageSize <= 0)
@@ -89,7 +89,7 @@ public static void RegisterCityAPI(WebApplication app)
 
                 var cities = db.Cities.Skip((pagination.Page - 1) * pagination.PageSize).Take(pagination.PageSize);
 
-                if (await cities?.CountAsync() == 0)
+                if (!await cities?.AnyAsync())
                 {
                     return Results.NotFound();
                 }
@@ -107,7 +107,7 @@ public static void RegisterCityAPI(WebApplication app)
             })
            .WithMetadata(new SwaggerOperationAttribute(
                summary: CityEndpointMetadataMessages.MESSAGE_CITY_PAGEDLIST_SUMMARY,
-                description: CityEndpointMetadataMessages.MESSAGE_CITY_SEARCH_DESCRIPTION
+                description: CityEndpointMetadataMessages.MESSAGE_CITY_PAGEDLIST_DESCRIPTION
                 ));
 
 

diff --git a/api/Routes/DepartmentRoutes.cs b/api/Routes/DepartmentRoutes.cs
@@ -124,7 +124,7 @@ public static void RegisterDepartmentAPI(WebApplication app)
                 ));
 
             app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/pagedList",
-                  async (PaginationModel pagination, DBContext db) =>
+                  async ([AsParameters] PaginationModel pagination, DBContext db) =>
                   {
 
                       if (pagination.Page <= 0 || pagination.PageSize <= 0)

diff --git a/api/Routes/NaturalAreaRoutes.cs b/api/Routes/NaturalAreaRoutes.cs
@@ -3,6 +3,8 @@
 using Swashbuckle.AspNetCore.Annotations;
 using Microsoft.EntityFrameworkCore;
 using static api.Utils.Messages.EndpointMetadata;
+using api.Models;
+using Microsoft.AspNetCore.Mvc;
 
 namespace api.Routes
 {
@@ -29,7 +31,8 @@ public static void RegisterNaturalAreaAPI(WebApplication app)
                 }
 
                 var naturalArea = await db.NaturalAreas
-                .Include(p=> p.CategoryNaturalArea)
+                .Include(p => p.CategoryNaturalArea)
+                .Include(p => p.Department)
                 .SingleOrDefaultAsync(p => p.Id == id);
 
                 if (naturalArea is null)
@@ -42,6 +45,76 @@ public static void RegisterNaturalAreaAPI(WebApplication app)
           .WithMetadata(new SwaggerOperationAttribute(
               summary: NaturalAreaEndpoint.MESSAGE_BYID_SUMMARY,
               description: NaturalAreaEndpoint.MESSAGE_BYID_DESCRIPTION));
+
+
+          app.MapGet($"{API_NATURALAREA_ROUTE_COMPLETE}/name/{{name}}", async (string name, DBContext db) =>
+            {
+                var naturalAreas = await db.NaturalAreas
+                                            .Include(p=> p.CategoryNaturalArea).IgnoreAutoIncludes()
+                                            .Include(p=> p.Department).IgnoreAutoIncludes()
+                                            .Where(x => x.Name!.ToUpper().Equals(name.Trim().ToUpper())).ToListAsync();
+
+                if (naturalAreas is null)
+                {
+                    return Results.NotFound();
+                }
+
+                return Results.Ok(naturalAreas);
+            })
+            .WithMetadata(new SwaggerOperationAttribute(
+                summary: NaturalAreaEndpoint.MESSAGE_BYNAME_SUMMARY,
+                description: NaturalAreaEndpoint.MESSAGE_BYNAME_DESCRIPTION
+                ));
+
+            app.MapGet($"{API_NATURALAREA_ROUTE_COMPLETE}/search/{{keyword}}", (string keyword, DBContext db) =>
+            {
+                string wellFormedKeyword = keyword.Trim().ToUpper().Normalize();
+                var naturalAreas = db.NaturalAreas.ToList();
+
+                var departments = Functions.FilterObjectListPropertiesByKeyword<NaturalArea>(naturalAreas, wellFormedKeyword);
+
+                if (departments.Count == 0)
+                {
+                    return Results.NotFound();
+                }
+
+                return Results.Ok(departments);
+            })
+            .WithMetadata(new SwaggerOperationAttribute(
+                summary: NaturalAreaEndpoint.MESSAGE_SEARCH_SUMMARY, 
+                description: NaturalAreaEndpoint.MESSAGE_SEARCH_DESCRIPTION
+                ));
+
+            app.MapGet($"{API_NATURALAREA_ROUTE_COMPLETE}/pagedList",
+                  async ([AsParameters] PaginationModel pagination, DBContext db) =>
+                  {
+
+                      if (pagination.Page <= 0 || pagination.PageSize <= 0)
+                      {
+                          return Results.BadRequest();
+                      }
+
+                      var naturalAreaPaged = db.NaturalAreas.Skip((pagination.Page - 1) * pagination.PageSize).Take(pagination.PageSize);
+
+                      if (!await naturalAreaPaged?.AnyAsync())
+                      {
+                          return Results.NotFound();
+                      }
+
+                      var paginationResponse = new PaginationResponseModel<NaturalArea>
+                      {
+                          Page = pagination.Page,
+                          PageSize = pagination.PageSize,
+                          TotalRecords = await db.NaturalAreas.CountAsync(),
+                          Data = await naturalAreaPaged.ToListAsync(),
+                      };
+
+                      return Results.Ok(paginationResponse);
+                  })
+         .WithMetadata(new SwaggerOperationAttribute(
+             summary: NaturalAreaEndpoint.MESSAGE_PAGEDLIST_SUMMARY,
+              description: NaturalAreaEndpoint.MESSAGE_PAGEDLIST_DESCRIPTION
+              ));
         }
     }
 }
diff --git a/api/Routes/PresidentRoutes.cs b/api/Routes/PresidentRoutes.cs
@@ -96,7 +96,7 @@ public static void RegisterPresidentApi(WebApplication app)
             ));
 
             app.MapGet($"{API_PRESIDENT_ROUTE_COMPLETE}/pagedList",
-            async (PaginationModel pagination, DBContext db) =>
+            async ([AsParameters] PaginationModel pagination, DBContext db) =>
             {
 
                 if (pagination.Page <= 0 || pagination.PageSize <= 0)

diff --git a/api/Routes/TouristicAttactionRoutes.cs b/api/Routes/TouristicAttactionRoutes.cs
@@ -75,7 +75,7 @@ public static void RegisterTuristicAttactionAPI(WebApplication app)
                 description: TouristAttractionEndpointMetadata.MESSAGE_TOURIST_ATTRACTION_SEARCH_DESCRIPTION));
 
             app.MapGet($"{API_TOURISTIC_ROUTE_COMPLETE}/pagedList",
-           async (PaginationModel pagination, DBContext db) =>
+           async ([AsParameters] PaginationModel pagination, DBContext db) =>
            {
 
                if (pagination.Page <= 0 || pagination.PageSize <= 0)

diff --git a/api/Utils/Messages.cs b/api/Utils/Messages.cs
@@ -96,6 +96,12 @@ public struct NaturalAreaEndpoint
                 public const string MESSAGE_LIST_DESCRIPTION = " This endpoint returns a list of natural areas  in Colombia";
                 public const string MESSAGE_BYID_SUMMARY = "Natural area information by Id";
                 public const string MESSAGE_BYID_DESCRIPTION = "This endpoint returns the information for the natural area with the provided id";
+                public const string MESSAGE_BYNAME_SUMMARY = "Natural place by name";
+                public const string MESSAGE_BYNAME_DESCRIPTION = "This endpoint returns an specific natural places by the provided name";
+                public const string MESSAGE_SEARCH_SUMMARY = "Search natural places by keyword ";
+                public const string MESSAGE_SEARCH_DESCRIPTION = "This endpoint returns a list of touristic attractions any of the following fields(Name, Description,LastName,Latitude, Longitude) match the provided keyword ";
+                public const string MESSAGE_PAGEDLIST_SUMMARY = "List of natural places using pagination - api/v1/naturalarea/pagedList?page=1&pagesize=10";
+                public const string MESSAGE_PAGEDLIST_DESCRIPTION = "This endpoint returns a list of natural places in Colombia using pagination including page, pagesize, total records and data, example api/v1/naturalarea/pagedList?page=1&pagesize=10";
             }
 
         }

diff --git a/api/Utils/PaginationModel.cs b/api/Utils/PaginationModel.cs
@@ -6,8 +6,8 @@ namespace api.Utils
 
     public class PaginationModel
     {
-        public string? SortBy { get; init; }
-        public SortDirection SortDirection { get; init; }
+        //public string? SortBy { get; init; }
+        //public SortDirection SortDirection { get; init; }
         public int Page { get; init; }
         public int PageSize { get; set; }
 
@@ -27,8 +27,8 @@ public class PaginationModel
 
             var result = new PaginationModel
             {
-                SortBy = context.Request.Query[sortByKey],
-                SortDirection = sortDirection,
+                //SortBy = context.Request.Query[sortByKey],
+                //SortDirection = sortDirection,
                 Page = page,
                 PageSize = pageSize
 

diff --git a/api/api.csproj b/api/api.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>