Generic controller template implementing basic CRUD functions:
- create entity from TCreateDto
- read entities using List<TDto>
- read entity with given id using TOneDto
- update entity with given id from TCreateDto
- delete entity with given id.
Create the controller mapping loader in the API project:
using CrudCore.API.Mapping;
public class AppMappingProfile : MappingProfile
{
public AppMappingProfile() : base(Assembly.GetExecutingAssembly()) { }
}
For any entity:
Add an interface to the entity:
using CrudCore.Objects;
[DisplayName("klient")]
public class Client:IIdentifiable
{
public int Id { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
public virtual List<Order> Orders { get; set; }
}
(Optional) You could add name attribute to the entity ().
"klient"
Create models for the entity:
public class ClientDto : CreateClientDto
{
public int Id { get; set; }
}
public class ClientSimplyDto
{
public int Id { get; set; }
public string Name { get; set; }
}
public class CreateClientDto
{
public string FirstName { get; set; }
public string LastName { get; set; }
}
Create the AutoMapper mapping class (which inherits from the SelfMapFrom generic class):
using CrudCore.API.Mapping;
public class ClientMapping : SelfMapFrom<Client>
{
protected override void CreateMaps(Profile profile)
{
profile.CreateMap<Client, ClientDto>();
profile.CreateMap<Client, ClientSimplyDto>()
.ForMember(p => p.Name, x => x.MapFrom(c => $"{c.FirstName} {c.LastName}"));
profile.CreateMap<ClientDto, Client>();
profile.CreateMap<CreateClientDto, Client>();
}
}
Create the controller (which inherits from the EntityControllerTemplate generic class):
using CrudCore.API;
using Microsoft.AspNetCore.Mvc;
[Route("api/client")]
[Authorize(Roles = RoleNames.Admin)]
public class ClientController
: EntityControllerTemplate<Client, ClientDto, ClientSimplyDto, CreateClientDto>
{
public ClientController(ApplicationDbContext context, IMapper mapper)
: base(context, mapper) { }
}
And that's all!
This is the result:
Customize controllers functions
You can use entity functions:
Creater to create new entity,
Reader to get list of entities,
Reader2 to get one entity with given id,
Updater to update entity with given id,
Deleter to delete entity with given id.
Those functions have two methods:
public EntityFunctionTemplate<TEntity> SetEntityAction(Action<TEntity> entityAction){}
public EntityFunctionTemplate<TEntity> SetQueryableFunction(Func<IQueryable<TEntity>, IQueryable<TEntity>> includeFunc){}
The SetEntityAction method validate the entity:
Creator.SetEntityAction(ValidateNewEntity);
private void ValidateNewEntity(Product entity)
{
var duplicate = _set.FirstOrDefault(
p => p.Name.ToLower() == entity.Name.ToLower() && p.Quality == entity.Quality);
if (duplicate != null)
{
throw new CustomException($"Produkt o nazwie ${entity.Name} istnieje już w bazie danych!");
}
duplicate = _set.FirstOrDefault(p => p.Code == entity.Code && p.Quality == entity.Quality);
if (duplicate != null)
{
throw new CustomException($"Produkt o kodzie ${entity.Code} istnieje już w bazie danych!");
}
}
The SetQueryableFunction method manipulate the entitys set:
[NonAction]
public override Task Remove(int id) => base.Remove(id);
For authorization off use:
[AllowAnonymous]
public override Task<List<ProductDto>> GetAll() => base.GetAll();
Using EntityCRUD class
For make more customisation use the EntityCRUD class insted of the EntityControllerTemplate class.
The EntityCRUD class isn't controller, but is the container includes basic CRUD functions.
Example:
[Controller]
[Route("api/order")]
public class OrderController : EntityCRUD<Order>
{
public OrderController(ApplicationDbContext context, IMapper mapper) : base(context, mapper)
{
Reader2.SetQueryableFunction(entities => entities.Include(p => p.Products));
}
[HttpGet]
public async Task GetAll()
=> await Reader.GetDtos<OrderDto>();
[HttpGet("{id}")]
public async Task GetById(int id)
=> await Reader2.GetDtoById<OrderDetailsDto>(id);
[HttpPost]
public async Task<int> AddNew([FromBody] CreateOrderDto dto)
=> await Creator.AddEntity(dto);
}
More information you can find in the CRUDAPI project in this solution.
