Flavio.Santos.NetCore.ApiResponse 1.0.7

FDS.NetCore.ApiResponse

🚀 FDS.UuidV7.NetCore is a lightweight .NET library for generating UUID v7 (time-based UUIDs) according to the official specification.

📦 Installation

You can install this package via NuGet Package Manager:

dotnet add package Flavio.Santos.NetCore.ApiResponse --version 1.0.2

Or using Package Manager Console:

Install-Package Flavio.Santos.NetCore.ApiResponse -Version 1.0.2

🚀 Usage

Creating a Standard API Response

Adding a New Client

public async Task<Response<ClientDto>> AddAsync(ClientRequestDto request)
{
    if (await _clientRepository.ExistsByNameAsync(request.Name))
    {
        return Result.Create<ClientDto>(
            actionType: ActionType.VALIDATION_ERROR,
            message: "A client with this name already exists."
        );
    }

    var client = new Client(Guid.NewGuid(), request.Name);
    await _clientRepository.AddAsync(client);
    var clientDto = new ClientDto { Id = client.Id, Name = client.Name };

    return Result.Create(
        actionType: ActionType.CREATE,
        message: "Client created successfully.",
        data: clientDto
    );
}

Deleting a Client

public async Task<Response<bool>> DeleteAsync(Guid id)
{
    var client = await _clientRepository.GetByIdAsync(id);

    if (client is null)
    {
        return Result.Create<bool>(
            actionType: ActionType.NOT_FOUND,
            message: "Client not found."
        );
    }

    await _clientRepository.DeleteAsync(id);

    return Result.Create<bool>(
        actionType: ActionType.DELETE,
        message: "Client deleted successfully."
    );
}

Example of Using the New LogCreateAsync() Method

Now, when creating a new order, we log an audit entry using LogCreateAsync.

Creating a New Order (OrderService)

public class OrderService
{
    private readonly IOrderRepository _orderRepository;
    private readonly IAuditLogService _auditLogService;

    public OrderService(IOrderRepository orderRepository, IAuditLogService auditLogService)
    {
        _orderRepository = orderRepository;
        _auditLogService = auditLogService;
    }

    public async Task<Response<OrderDto>> CreateOrderAsync(OrderRequestDto request)
    {
        try
        {
            if (await _orderRepository.ExistsByReferenceAsync(request.Reference))
            {
                string errorMsg = "An order with this reference already exists.";
                
                await _auditLogService.LogValidationErrorAsync(errorMsg, request);
                
                return Result.Create<OrderDto>(
                    actionType: ActionType.VALIDATION_ERROR,
                    message: errorMsg
                );
            }

            var order = new Order(Guid.NewGuid(), request.Reference, request.Amount);
            await _orderRepository.AddAsync(order);
            var orderDto = new OrderDto { Id = order.Id, Reference = order.Reference, Amount = order.Amount };

            string successMsg = "Order created successfully.";

            // ⬇️ Logging the creation event using LogCreateAsync
            await _auditLogService.LogCreateAsync(successMsg, request, orderDto);

            return Result.CreateSuccess(successMsg, orderDto);
        }
        catch (Exception ex)
        {
            return Result.Create<OrderDto>(
                actionType: ActionType.ERROR,
                message: $"An unexpected error occurred: {ex.Message}"
            );
        }
    }
}

How Is LogCreateAsync() Used?

1️⃣ Before saving the order, we check if it already exists → If so, we log a validation error (LogValidationErrorAsync).

2️⃣ We create the order in the database.

3️⃣ We log the creation event (LogCreateAsync), including both the request and response data.

4️⃣ We return a standardized response (CreateSuccess).

📌 Output Example

Client Not Found (404)

{
  "isSuccess": false,
  "message": "Client not found.",
  "statusCode": 404
}

Client Created Successfully (201)

{
  "isSuccess": true,
  "message": "Client created successfully.",
  "statusCode": 201,
  "data": {
    "id": "bf5d9501-032f-447b-bfaf-8cc4fff19e61",
    "name": "Teste"
  }
}

Client Already Exists (400)

{
  "isSuccess": false,
  "message": "A client with this name already exists.",
  "statusCode": 400
}

Client Deleted Successfully (200)

{
  "isSuccess": true,
  "message": "Client deleted successfully.",
  "statusCode": 200
}

🎯 Features

• Standardized API response format
• Built-in status codes and messages
• Easy integration with Clean Architecture
• Fully compatible with .NET 8

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Links

• NuGet Package: Flavio.Santos.NetCore.ApiResponse
• Author LinkedIn: Flavio Santos

🔙 Back to Main README