REST API Development Best Practices. Automapper and Repositories

ranahamid · Mar 8, 2022 · 01ad6d4 · 01ad6d4
1 parent 93e0f5a
commit 01ad6d4
Show file tree

Hide file tree

Showing 14 changed files with 228 additions and 22 deletions.
diff --git a/HotelListing.API/Configurations/MapperConfig.cs b/HotelListing.API/Configurations/MapperConfig.cs
@@ -0,0 +1,21 @@
+using AutoMapper;
+using HotelListing.API.Data;
+using HotelListing.API.Models.Country;
+using HotelListing.API.Models.Hotel;
+
+namespace HotelListing.API.Configurations
+{
+    public class MapperConfig : Profile
+    {
+        public MapperConfig()
+        {
+            CreateMap<Country, CreateCountryDto>().ReverseMap();
+            CreateMap<Country, GetCountryDto>().ReverseMap();
+            CreateMap<Country, CountryDto>().ReverseMap();
+            CreateMap<Country, UpdateCountryDto>().ReverseMap();
+
+            CreateMap<Hotel, HotelDto>().ReverseMap();
+
+        }
+    }
+}
diff --git a/HotelListing.API/Contracts/ICountriesRepository.cs b/HotelListing.API/Contracts/ICountriesRepository.cs
@@ -0,0 +1,9 @@
+using HotelListing.API.Data;
+
+namespace HotelListing.API.Contracts
+{
+    public interface ICountriesRepository : IGenericRepository<Country>
+    {
+        Task<Country> GetDetails(int id);
+    }
+}
diff --git a/HotelListing.API/Contracts/IGenericRepository.cs b/HotelListing.API/Contracts/IGenericRepository.cs
@@ -0,0 +1,12 @@
+namespace HotelListing.API.Contracts
+{
+    public interface IGenericRepository<T> where T : class
+    {
+        Task<T> GetAsync(int? id);
+        Task<List<T>> GetAllAsync();
+        Task<T> AddAsync(T entity);
+        Task DeleteAsync(int id);
+        Task UpdateAsync(T entity);
+        Task<bool> Exists(int id);
+    }
+}
diff --git a/HotelListing.API/Controllers/CountriesController.cs b/HotelListing.API/Controllers/CountriesController.cs
@@ -6,61 +6,76 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
 using HotelListing.API.Data;
+using HotelListing.API.Models.Country;
+using AutoMapper;
+using HotelListing.API.Contracts;
 
 namespace HotelListing.API.Controllers
 {
     [Route("api/[controller]")]
     [ApiController]
     public class CountriesController : ControllerBase
     {
-        private readonly HotelListingDbContext _context;
+        private readonly IMapper _mapper;
+        private readonly ICountriesRepository _countriesRepository;
 
-        public CountriesController(HotelListingDbContext context)
+        public CountriesController(IMapper mapper, ICountriesRepository countriesRepository)
         {
-            _context = context;
+            this._mapper = mapper;
+            this._countriesRepository = countriesRepository;
         }
 
         // GET: api/Countries
         [HttpGet]
-        public async Task<ActionResult<IEnumerable<Country>>> GetCountries()
+        public async Task<ActionResult<IEnumerable<GetCountryDto>>> GetCountries()
         {
-            var countries = await _context.Countries.ToListAsync();
-            return Ok(countries);
+            var countries = await _countriesRepository.GetAllAsync();
+            var records = _mapper.Map<List<GetCountryDto>>(countries);
+            return Ok(records);
         }
 
         // GET: api/Countries/5
         [HttpGet("{id}")]
-        public async Task<ActionResult<Country>> GetCountry(int id)
+        public async Task<ActionResult<CountryDto>> GetCountry(int id)
         {
-            var country = await _context.Countries.FindAsync(id);
+            var country = await _countriesRepository.GetDetails(id);
 
             if (country == null)
             {
                 return NotFound();
             }
 
-            return Ok(country);
+            var countryDto = _mapper.Map<CountryDto>(country);
+
+            return Ok(countryDto);
         }
 
         // PUT: api/Countries/5
         // To protect from overposting attacks, see https://go.microsoft.com/fwlink/?linkid=2123754
         [HttpPut("{id}")]
-        public async Task<IActionResult> PutCountry(int id, Country country)
+        public async Task<IActionResult> PutCountry(int id, UpdateCountryDto updateCountryDto)
         {
-            if (id != country.Id)
+            if (id != updateCountryDto.Id)
             {
                 return BadRequest("Invalid Record Id");
             }
 
-            _context.Entry(country).State = EntityState.Modified;
+            var country = await _countriesRepository.GetAsync(id);
+
+            if (country == null)
+            {
+                return NotFound();
+            }
+
+            _mapper.Map(updateCountryDto, country);
 
             try
             {
-                await _context.SaveChangesAsync();
+                await _countriesRepository.UpdateAsync(country);
             }
             catch (DbUpdateConcurrencyException)
             {
-                if (!CountryExists(id))
+                if (!await CountryExists(id))
                 {
                     return NotFound();
                 }
@@ -76,10 +91,11 @@ public async Task<IActionResult> PutCountry(int id, Country country)
         // POST: api/Countries
         // To protect from overposting attacks, see https://go.microsoft.com/fwlink/?linkid=2123754
         [HttpPost]
-        public async Task<ActionResult<Country>> PostCountry(Country country)
+        public async Task<ActionResult<Country>> PostCountry(CreateCountryDto createCountryDto)
         {
-            _context.Countries.Add(country);
-            await _context.SaveChangesAsync();
+            var country = _mapper.Map<Country>(createCountryDto);
+
+            await _countriesRepository.AddAsync(country);
 
             return CreatedAtAction("GetCountry", new { id = country.Id }, country);
         }
@@ -88,21 +104,20 @@ public async Task<ActionResult<Country>> PostCountry(Country country)
         [HttpDelete("{id}")]
         public async Task<IActionResult> DeleteCountry(int id)
         {
-            var country = await _context.Countries.FindAsync(id);
+            var country = await _countriesRepository.GetAsync(id);
             if (country == null)
             {
                 return NotFound();
             }
 
-            _context.Countries.Remove(country);
-            await _context.SaveChangesAsync();
+            await _countriesRepository.DeleteAsync(id);
 
             return NoContent();
         }
 
-        private bool CountryExists(int id)
+        private async Task<bool> CountryExists(int id)
         {
-            return _context.Countries.Any(e => e.Id == id);
+            return await _countriesRepository.Exists(id);
         }
     }
 }
diff --git a/HotelListing.API/HotelListing.API.csproj b/HotelListing.API/HotelListing.API.csproj
@@ -7,6 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="11.0.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.2" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="6.0.2">
       <PrivateAssets>all</PrivateAssets>

diff --git a/HotelListing.API/Models/Country/BaseCountryDto.cs b/HotelListing.API/Models/Country/BaseCountryDto.cs
@@ -0,0 +1,12 @@
+using System.ComponentModel.DataAnnotations;
+
+namespace HotelListing.API.Models.Country
+{
+    public abstract class BaseCountryDto
+    {
+        [Required]
+        public string Name { get; set; }
+        public string ShortName { get; set; }
+
+    }
+}
diff --git a/HotelListing.API/Models/Country/CountryDto.cs b/HotelListing.API/Models/Country/CountryDto.cs
@@ -0,0 +1,10 @@
+using HotelListing.API.Models.Hotel;
+
+namespace HotelListing.API.Models.Country
+{
+    public class CountryDto : BaseCountryDto
+    {
+        public int Id { get; set; }
+        public List<HotelDto> Hotels { get; set; }
+    }
+}
diff --git a/HotelListing.API/Models/Country/CreateCountryDto.cs b/HotelListing.API/Models/Country/CreateCountryDto.cs
@@ -0,0 +1,8 @@
+using System.ComponentModel.DataAnnotations;
+
+namespace HotelListing.API.Models.Country
+{
+    public class CreateCountryDto : BaseCountryDto
+    {
+    }
+}
diff --git a/HotelListing.API/Models/Country/GetCountryDto.cs b/HotelListing.API/Models/Country/GetCountryDto.cs
@@ -0,0 +1,9 @@
+using System.ComponentModel.DataAnnotations.Schema;
+
+namespace HotelListing.API.Models.Country
+{
+    public class GetCountryDto : BaseCountryDto
+    {
+        public int Id { get; set; }
+    }
+}
diff --git a/HotelListing.API/Models/Country/UpdateCountryDto.cs b/HotelListing.API/Models/Country/UpdateCountryDto.cs
@@ -0,0 +1,7 @@
+namespace HotelListing.API.Models.Country
+{
+    public class UpdateCountryDto : BaseCountryDto
+    {
+        public int Id { get; set; }
+    }
+}
diff --git a/HotelListing.API/Models/Hotel/HotelDto.cs b/HotelListing.API/Models/Hotel/HotelDto.cs
@@ -0,0 +1,11 @@
+namespace HotelListing.API.Models.Hotel
+{
+    public class HotelDto
+    {
+        public int Id { get; set; }
+        public string Name { get; set; }
+        public string Address { get; set; }
+        public double Rating { get; set; }
+        public int CountryId { get; set; }
+    }
+}
diff --git a/HotelListing.API/Program.cs b/HotelListing.API/Program.cs
@@ -1,4 +1,7 @@
+using HotelListing.API.Configurations;
+using HotelListing.API.Contracts;
 using HotelListing.API.Data;
+using HotelListing.API.Repository;
 using Microsoft.EntityFrameworkCore;
 using Serilog;
 
@@ -25,6 +28,11 @@
 
 builder.Host.UseSerilog((ctx, lc) => lc.WriteTo.Console().ReadFrom.Configuration(ctx.Configuration));
 
+builder.Services.AddAutoMapper(typeof(MapperConfig));
+
+builder.Services.AddScoped(typeof(IGenericRepository<>), typeof(GenericRepository<>));
+builder.Services.AddScoped<ICountriesRepository, CountriesRepository>();
+
 var app = builder.Build();
 
 // Configure the HTTP request pipeline.

diff --git a/HotelListing.API/Repository/CountriesRepository.cs b/HotelListing.API/Repository/CountriesRepository.cs
@@ -0,0 +1,22 @@
+using HotelListing.API.Contracts;
+using HotelListing.API.Data;
+using Microsoft.EntityFrameworkCore;
+
+namespace HotelListing.API.Repository
+{
+    public class CountriesRepository : GenericRepository<Country>, ICountriesRepository
+    {
+        private readonly HotelListingDbContext _context;
+
+        public CountriesRepository(HotelListingDbContext context) : base(context)
+        {
+            this._context = context;
+        }
+
+        public async Task<Country> GetDetails(int id)
+        {
+            return await _context.Countries.Include(q => q.Hotels)
+                .FirstOrDefaultAsync(q => q.Id == id);
+        }
+    }
+}
diff --git a/HotelListing.API/Repository/GenericRepository.cs b/HotelListing.API/Repository/GenericRepository.cs
@@ -0,0 +1,61 @@
+using AutoMapper;
+using AutoMapper.QueryableExtensions;
+using HotelListing.API.Contracts;
+using HotelListing.API.Data;
+using HotelListing.API.Models.Country;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Configuration;
+
+namespace HotelListing.API.Repository
+{
+    public class GenericRepository<T> : IGenericRepository<T> where T : class
+    {
+        private readonly HotelListingDbContext _context;
+
+        public GenericRepository(HotelListingDbContext context)
+        {
+            this._context = context;
+        }
+
+        public async Task<T> AddAsync(T entity)
+        {
+            await _context.AddAsync(entity);
+            await _context.SaveChangesAsync();
+            return entity;
+        }
+
+        public async Task DeleteAsync(int id)
+        {
+            var entity = await GetAsync(id);
+            _context.Set<T>().Remove(entity);
+            await _context.SaveChangesAsync();
+        }
+
+        public async Task<bool> Exists(int id)
+        {
+            var entity = await GetAsync(id);
+            return entity != null;
+        }
+
+        public async Task<List<T>> GetAllAsync()
+        {
+            return await _context.Set<T>().ToListAsync();
+        }
+
+        public async Task<T> GetAsync(int? id)
+        {
+            if (id is null)
+            {
+                return null;
+            }
+
+            return await _context.Set<T>().FindAsync(id);
+        }
+
+        public async Task UpdateAsync(T entity)
+        {
+            _context.Update(entity);
+            await _context.SaveChangesAsync();
+        }
+    }
+}