key4.Comments

NuGet that contains the Domain, Persistence, Commands and Queries to get, add, update, delete comments on any entity.

Initialization

StartUp

public void ConfigureServices(IServiceCollection services)
{
    ...
    services.AddK4Comments(Configuration);
    ...
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    ...
    app.EnsureDatabasesMigrated(env);
    ...
    app.UseK4Comments();
    ...
}

AutoMapperConfiguration

public static MapperConfiguration Configure()
    => new(cfg =>
    {
        cfg.AddMaps(...);

        cfg.AddK4Comments();
    });

Usage

GET / POST

Add a partial controller with GET / POST methods for an entity controller.

Example : MyEntityController.Comments.cs

using Host.Dtos.Common.Responses;
using key4.Comments.Application.Comments.Commands;
using key4.Comments.Application.Comments.Queries;
using key4.Comments.Host.Dtos.Comments.Requests;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace Host.Controllers;

public partial class MyEntityController
{
    #region Public Methods

    [HttpGet("{id}/comments")]
    [ProducesResponseType(typeof(IEnumerable<CommentGetByEntity.CommentDto>), StatusCodes.Status204NoContent)]
    [ProducesResponseType(StatusCodes.Status400BadRequest)]
    [ProducesResponseType(StatusCodes.Status401Unauthorized)]
    [ProducesResponseType(StatusCodes.Status403Forbidden)]
    [ProducesResponseType(StatusCodes.Status422UnprocessableEntity)]
    [ProducesResponseType(StatusCodes.Status500InternalServerError)]
    public async Task<ActionResult> GetCommentsAsync([FromRoute] Guid id)
        => Ok(await _mediator.Send(new CommentGetByEntity.Query { EntityId = id }));

    [Authorize]
    [HttpPost("{id}/comments")]
    [ProducesResponseType(typeof(CreatedDto), StatusCodes.Status200OK)]
    [ProducesResponseType(StatusCodes.Status400BadRequest)]
    [ProducesResponseType(StatusCodes.Status401Unauthorized)]
    [ProducesResponseType(StatusCodes.Status403Forbidden)]
    [ProducesResponseType(StatusCodes.Status422UnprocessableEntity)]
    [ProducesResponseType(StatusCodes.Status500InternalServerError)]
    public async Task<ActionResult> CreateCommentAsync(
        [FromRoute] Guid id,
        [FromBody] SyncCommentDto request)
    {
        var mappedRequest = _mapper.Map<CommentCreate.Command>(request);
        _mapper.Map(HttpContext.User, mappedRequest);
        mappedRequest.EntityId = id;
        return Ok(new CreatedDto(await _mediator.Send(mappedRequest)));
    }
    
    #endregion Public Methods
}

PUT / DELETE

Add a CommentController for all the PUTs / DELETEs for all the entities of the microservice.

using AutoMapper;
using key4.Comments.Application.Comments.Commands;
using key4.Comments.Host.Dtos.Comments.Requests;
using MediatR;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace Host.Controllers;

[Authorize]
[ApiController]
[ApiVersion("1.0")]
[Produces("application/json")]
[Route("operations/{operationId}/registration/comments")]
public class CommentController : ControllerBase
{
    #region Private Fields

    private readonly IMediator _mediator;
    private readonly IMapper _mapper;

    #endregion Private Fields

    #region Public Constructors

    public CommentController(IMediator mediator, IMapper mapper)
    {
        _mediator = mediator;
        _mapper = mapper;
    }

    #endregion Public Constructors

    #region Public Methods

    [HttpPut("{id}")]
    [ProducesResponseType(StatusCodes.Status204NoContent)]
    [ProducesResponseType(StatusCodes.Status400BadRequest)]
    [ProducesResponseType(StatusCodes.Status401Unauthorized)]
    [ProducesResponseType(StatusCodes.Status403Forbidden)]
    [ProducesResponseType(StatusCodes.Status422UnprocessableEntity)]
    [ProducesResponseType(StatusCodes.Status500InternalServerError)]
    public async Task<ActionResult> UpdateCommentAsync(
        [FromRoute] Guid id,
        [FromBody] SyncCommentDto request)
    {
        var mappedRequest = _mapper.Map<CommentUpdate.Command>(request);
        _mapper.Map(HttpContext.User, mappedRequest);
        mappedRequest.Id = id;
        await _mediator.Send(mappedRequest);
        return NoContent();
    }

    [HttpDelete("{id}")]
    [ProducesResponseType(StatusCodes.Status204NoContent)]
    [ProducesResponseType(StatusCodes.Status400BadRequest)]
    [ProducesResponseType(StatusCodes.Status401Unauthorized)]
    [ProducesResponseType(StatusCodes.Status403Forbidden)]
    [ProducesResponseType(StatusCodes.Status422UnprocessableEntity)]
    [ProducesResponseType(StatusCodes.Status500InternalServerError)]
    public async Task<ActionResult> DeleteCommentAsync([FromRoute] Guid id)
    {
        var request = new CommentDelete.Command { Id = id };
        _mapper.Map(HttpContext.User, request);
        await _mediator.Send(request);
        return NoContent();
    }

    #endregion Public Methods
}