diff --git a/Server/Controllers/CountryManagementController.cs b/Server/Controllers/CountryManagementController.cs index 745c187..c047746 100644 --- a/Server/Controllers/CountryManagementController.cs +++ b/Server/Controllers/CountryManagementController.cs @@ -46,14 +46,14 @@ public class CountryManagementController : ControllerBase } [HttpGet("{id}")] - public async Task GetCountry(int id) + public async Task GetCountry(int id, [FromQuery] string? fields) { if (!await _countryManagementService.IsCountryExists(id)) { return NotFound(); } - var result = await _countryManagementService.GetCountry(id); + var result = await _countryManagementService.GetCountry(id, fields); if (!result.isSucceed) { @@ -78,7 +78,7 @@ public class CountryManagementController : ControllerBase return BadRequest(result.message); } - return Ok(result); + return Ok(result.country); } [HttpDelete("{id}")] diff --git a/Server/Helpers/DataShaper.cs b/Server/Helpers/DataShaper.cs new file mode 100644 index 0000000..a51111d --- /dev/null +++ b/Server/Helpers/DataShaper.cs @@ -0,0 +1,69 @@ +using System.Dynamic; +using System.Reflection; + +namespace Server.Helpers; + +public class DataShaper : IDataShaper +{ + public PropertyInfo[] Properties { get; set; } + + public DataShaper() + { + Properties = typeof(T).GetProperties(BindingFlags.Public | BindingFlags.Instance); + } + + public IEnumerable ShapeData(IEnumerable entities, string? fieldsString) + { + var requiredProperties = GetRequiredProperties(fieldsString); + return FetchData(entities, requiredProperties); + } + + public ExpandoObject ShapeData(T entity, string? fieldsString) + { + var requiredProperties = GetRequiredProperties(fieldsString); + return FetchDataForEntity(entity, requiredProperties); + } + + private IEnumerable GetRequiredProperties(string? fieldsString) + { + var requiredProperties = new List(); + if (!string.IsNullOrWhiteSpace(fieldsString)) + { + var fields = fieldsString.Split(',', StringSplitOptions.RemoveEmptyEntries); + foreach (var field in fields) + { + var property = Properties.FirstOrDefault(pi => pi.Name.Equals(field.Trim(), StringComparison.InvariantCultureIgnoreCase)); + if (property == null) + continue; + requiredProperties.Add(property); + } + } + else + { + requiredProperties = Properties.ToList(); + } + return requiredProperties; + } + + private IEnumerable FetchData(IEnumerable entities, IEnumerable requiredProperties) + { + var shapedData = new List(); + foreach (var entity in entities) + { + var shapedObject = FetchDataForEntity(entity, requiredProperties); + shapedData.Add(shapedObject); + } + return shapedData; + } + + private ExpandoObject FetchDataForEntity(T entity, IEnumerable requiredProperties) + { + var shapedObject = new ExpandoObject(); + foreach (var property in requiredProperties) + { + var objectPropertyValue = property.GetValue(entity); + shapedObject.TryAdd(property.Name, objectPropertyValue); + } + return shapedObject; + } +} \ No newline at end of file diff --git a/Server/Helpers/IDataShaper.cs b/Server/Helpers/IDataShaper.cs new file mode 100644 index 0000000..32eb58b --- /dev/null +++ b/Server/Helpers/IDataShaper.cs @@ -0,0 +1,9 @@ +using System.Dynamic; + +namespace Server.Helpers; + +public interface IDataShaper +{ + IEnumerable ShapeData(IEnumerable entities, string? fieldsString); + ExpandoObject ShapeData(T entity, string? fieldsString); +} \ No newline at end of file diff --git a/Server/Program.cs b/Server/Program.cs index 55e1cb0..844aef8 100644 --- a/Server/Program.cs +++ b/Server/Program.cs @@ -5,6 +5,7 @@ using Microsoft.EntityFrameworkCore; using Microsoft.IdentityModel.Tokens; using Microsoft.OpenApi.Models; using Newtonsoft.Json; +using Newtonsoft.Json.Serialization; using Server.Configurations; using Server.Data; using Server.Helpers; @@ -15,8 +16,11 @@ var builder = WebApplication.CreateBuilder(args); // Add services to the container. -builder.Services.AddControllers().AddNewtonsoftJson(options => - options.SerializerSettings.Formatting = Formatting.Indented); +builder.Services.AddControllers().AddNewtonsoftJson(options => { + options.SerializerSettings.Formatting = Formatting.Indented; + options.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver(); + +}); // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle builder.Services.AddEndpointsApiExplorer(); @@ -88,6 +92,8 @@ builder.Services.AddScoped(); builder.Services.AddScoped, SortHelper>(); +builder.Services.AddScoped, DataShaper>(); + // Adding DB Context with PostgreSQL var connectionString = builder.Configuration.GetConnectionString("DefaultConnection"); builder.Services.AddDbContext(options => diff --git a/Server/Services/CountryManagementService.cs b/Server/Services/CountryManagementService.cs index 50c5dd7..ed4f3a0 100644 --- a/Server/Services/CountryManagementService.cs +++ b/Server/Services/CountryManagementService.cs @@ -1,3 +1,4 @@ +using System.Dynamic; using System.Linq.Dynamic.Core; using AutoMapper; using AutoMapper.QueryableExtensions; @@ -15,13 +16,16 @@ public class CountryManagementService : ICountryManagementService private readonly ApplicationDbContext _dbContext; private readonly IMapper _mapper; private readonly ISortHelper _countrySortHelper; + private readonly IDataShaper _countryDataShaper; public CountryManagementService(ApplicationDbContext dbContext, - IMapper mapper, ISortHelper countrySortHelper) + IMapper mapper, ISortHelper countrySortHelper, + IDataShaper countryDataShaper) { _dbContext = dbContext; _mapper = mapper; _countrySortHelper = countrySortHelper; + _countryDataShaper = countryDataShaper; } public async Task<(bool isSucceed, string message, CountryDto country)> AddCountry(CreateCountryDto createCountryDto) @@ -34,7 +38,7 @@ public class CountryManagementService : ICountryManagementService return (true, String.Empty, _mapper.Map(country)); } - public async Task<(bool isSucceed, string message, IEnumerable countries, + public async Task<(bool isSucceed, string message, IEnumerable countries, PagingMetadata pagingMetadata)> GetCountries(CountryParameters parameters) { var dbCountries = _dbContext.Countries.AsQueryable(); @@ -59,10 +63,9 @@ public class CountryManagementService : ICountryManagementService var pagingMetadata = ApplyPaging(ref dbCountries, parameters.PageNumber, parameters.PageSize); - var countryDtos = - dbCountries.ProjectTo(_mapper.ConfigurationProvider); + var shapedCountiesData = _countryDataShaper.ShapeData(dbCountries, parameters.Fields); - return (true, "", countryDtos, pagingMetadata); + return (true, "", shapedCountiesData, pagingMetadata); void SearchByAllCountryFields(ref IQueryable countries, string? search) @@ -117,21 +120,22 @@ public class CountryManagementService : ICountryManagementService } } - public async Task<(bool isSucceed, string message, CountryDto country)> GetCountry(int id) + public async Task<(bool isSucceed, string message, ExpandoObject country)> GetCountry(int id, string? fields) { var dbCountry = await _dbContext.Countries.Where(c => c.Id == id) - .ProjectTo(_mapper.ConfigurationProvider) .FirstOrDefaultAsync(); if (dbCountry == null) { return (false, $"Country doesn't exist", null)!; } + + var shapedCountryData = _countryDataShaper.ShapeData(dbCountry, fields); - return (true, "", dbCountry); + return (true, "", shapedCountryData); } - public async Task<(bool isSucceed, string message, CountryDto country)> UpdateCountry(UpdateCountryDto updateCountryDto) + public async Task<(bool isSucceed, string message, UpdateCountryDto country)> UpdateCountry(UpdateCountryDto updateCountryDto) { var country = _mapper.Map(updateCountryDto); _dbContext.Entry(country).State = EntityState.Modified; @@ -152,7 +156,7 @@ public class CountryManagementService : ICountryManagementService var dbCountry = await _dbContext.Countries.FirstOrDefaultAsync(c => c.Id == country.Id); - return (true, String.Empty, _mapper.Map(dbCountry)); + return (true, String.Empty, _mapper.Map(dbCountry)); } public async Task<(bool isSucceed, string message)> DeleteCountry(int id) diff --git a/Server/Services/ICountryManagementService.cs b/Server/Services/ICountryManagementService.cs index bccc14a..a75871c 100644 --- a/Server/Services/ICountryManagementService.cs +++ b/Server/Services/ICountryManagementService.cs @@ -1,3 +1,4 @@ +using System.Dynamic; using Server.Models; using SharedModels.DataTransferObjects; using SharedModels.QueryStringParameters; @@ -8,10 +9,10 @@ public interface ICountryManagementService { Task<(bool isSucceed, string message, CountryDto country)> AddCountry(CreateCountryDto createCountryDto); - Task<(bool isSucceed, string message, IEnumerable countries, + Task<(bool isSucceed, string message, IEnumerable countries, PagingMetadata pagingMetadata)> GetCountries(CountryParameters parameters); - Task<(bool isSucceed, string message, CountryDto country)> GetCountry(int id); - Task<(bool isSucceed, string message, CountryDto country)> UpdateCountry(UpdateCountryDto updateCountryDto); + Task<(bool isSucceed, string message, ExpandoObject country)> GetCountry(int id, string? fields); + Task<(bool isSucceed, string message, UpdateCountryDto country)> UpdateCountry(UpdateCountryDto updateCountryDto); Task<(bool isSucceed, string message)> DeleteCountry(int id); Task IsCountryExists(int id); } \ No newline at end of file diff --git a/SharedModels/QueryStringParameters/CountryParameters.cs b/SharedModels/QueryStringParameters/CountryParameters.cs index 291be52..24e53e3 100644 --- a/SharedModels/QueryStringParameters/CountryParameters.cs +++ b/SharedModels/QueryStringParameters/CountryParameters.cs @@ -5,6 +5,7 @@ public class CountryParameters : QueryStringParameters public CountryParameters() { Sort = "id"; + Fields = "id,code,name,states"; } public string? Code { get; set; } diff --git a/SharedModels/QueryStringParameters/QueryStringParameters.cs b/SharedModels/QueryStringParameters/QueryStringParameters.cs index 65ebd22..ba6f037 100644 --- a/SharedModels/QueryStringParameters/QueryStringParameters.cs +++ b/SharedModels/QueryStringParameters/QueryStringParameters.cs @@ -14,4 +14,5 @@ public class QueryStringParameters public string? Search { get; set; } public string? Sort { get; set; } + public string? Fields { get; set; } } \ No newline at end of file