Refactor requests to use ApiResponse for standardized handling

Updated request and handler interfaces to return ApiResponse<T> instead of raw types for more structured responses. Modified controllers with streamlined result-handling logic, replacing try-catch error responses. Introduced ApiResponse utilities and custom controller base for better response encapsulation.

Author: TranHuyThang9999

Common/Extensions/ApiResponseExtensions.cs

@@ -0,0 +1,8 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace PaymentCoreServiceApi.Common.Extensions;
+
+public abstract class ApiResponseExtensions
+{
+
+}

Common/Mediator/BaseApiResponseHandler.cs

@@ -0,0 +1,7 @@
+namespace PaymentCoreServiceApi.Common.Mediator;
+
+public abstract class BaseApiResponseHandler<TRequest, TResponse> : IRequestApiResponseHandler<TRequest, TResponse>
+    where TRequest : IRequestApiResponse<TResponse>
+{
+    public abstract Task<ApiResponse<TResponse>> Handle(TRequest request, CancellationToken cancellationToken);
+}

Common/Mediator/IRequestApiResponse.cs

@@ -0,0 +1,7 @@
+using MediatR;
+
+namespace PaymentCoreServiceApi.Common.Mediator;
+
+public interface IRequestApiResponse<T> : IRequest<ApiResponse<T>>
+{
+}

Common/Mediator/IRequestApiResponseHandler.cs

@@ -0,0 +1,8 @@
+using MediatR;
+
+namespace PaymentCoreServiceApi.Common.Mediator;
+
+public interface IRequestApiResponseHandler<TRequest, TResponse> : IRequestHandler<TRequest, ApiResponse<TResponse>>
+    where TRequest : IRequestApiResponse<TResponse>
+{
+}

Common/Responses.cs

@@ -0,0 +1,54 @@
+using System.Text.Json.Serialization;
+
+namespace PaymentCoreServiceApi.Common;
+
+public class ApiResponse<T>
+{
+    [JsonIgnore]
+    public int HttpStatus { get; set; } = 200;
+
+    public int Code { get; set; } = 0;
+    public string Message { get; set; } = "Success";
+
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+    public T? Data { get; set; }
+
+    public ApiResponse() { }
+
+    public ApiResponse(T data, string message = "Success", int code = 0, int httpStatus = 200)
+    {
+        Data = data;
+        Message = message;
+        Code = code;
+        HttpStatus = httpStatus;
+    }
+
+    public ApiResponse(string message, int code = 0, int httpStatus = 400)
+    {
+        Data = default;
+        Message = message;
+        Code = code;
+        HttpStatus = httpStatus;
+    }
+
+    public static ApiResponse<T> Success(T data, string message = "Success")
+        => new(data, message, 0, 200);
+
+    public static ApiResponse<T> NotFound(string message = "Not Found", int code = 40401)
+        => new(message, code, 404);
+
+    public static ApiResponse<T> BadRequest(string message = "Bad Request", int code = 40001)
+        => new(message, code, 400);
+
+    public static ApiResponse<T> Unauthorized(string message = "Unauthorized", int code = 40101)
+        => new(message, code, 401);
+
+    public static ApiResponse<T> Forbidden(string message = "Forbidden", int code = 40301)
+        => new(message, code, 403);
+
+    public static ApiResponse<T> Conflict(string message = "Conflict", int code = 40901)
+        => new(message, code, 409);
+
+    public static ApiResponse<T> InternalServerError(string message = "Internal Server Error", int code = 50001)
+        => new(message, code, 500);
+}

Controllers/AuthController.cs

@@ -9,7 +9,7 @@ namespace PaymentCoreServiceApi.Controllers;
 [ApiController]
 [Route("api/[controller]")]
 [Authorize]
-public class AuthController : BaseController
+public class AuthController : ControllerBaseCustom
 {
     private readonly IMediator _mediator;
 
@@ -21,14 +21,7 @@ public AuthController(IMediator mediator)
     [AllowAnonymous]
     public async Task <IActionResult> Login([FromBody] LoginCommand command)
     {
-        try
-        {
-            var response = await _mediator.Send(command);
-            return SuccessResponse(response);
-        }
-        catch (UnauthorizedAccessException)
-        {
-            return Unauthorized();
-        }
+        var response = await _mediator.Send(command);
+        return Ok(response);
     }
 }

Controllers/BankAccountController.cs

@@ -1,3 +1,4 @@
+using System.Net;
 using MediatR;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
@@ -7,7 +8,7 @@ namespace PaymentCoreServiceApi.Controllers;
 [ApiController]
 [Route("api/[controller]")]
 [Authorize]
-public class BankAccountController: BaseController
+public class BankAccountController: ControllerBaseCustom
 {
     private readonly IMediator _mediator;
 
@@ -18,15 +19,8 @@ public BankAccountController(IMediator mediator)
     [HttpPost("create-bank-account")]
     public async Task<IActionResult> Create([FromBody] CreateBankAccountCommand command)
     {
-        try
-        {
-            var bankAccount = await _mediator.Send(command);
-            return SuccessResponse(bankAccount);
-        }
-        catch (Exception ex)
-        {
-            return ErrorResponse(ex.Message, 400);
-        }
+        var result = await _mediator.Send(command);
+        return OK(result);
     }
 
 }

Controllers/BaseController.cs

@@ -1,38 +1,13 @@
-using System.Text.Json.Serialization;
 using Microsoft.AspNetCore.Mvc;
+using PaymentCoreServiceApi.Common;
 
 namespace PaymentCoreServiceApi.Controllers;
 
-public class ApiResponseModel
+[ApiController]
+public abstract class ControllerBaseCustom : ControllerBase
 {
-    public int Code { get; set; }
-    public string Message { get; set; } = string.Empty;
-
-    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
-    public object? Data { get; set; }
-}
-
-public abstract class BaseController : ControllerBase
-{
-    protected IActionResult ApiResponse(int code, string message, object? data = null)
-    {
-        var response = new ApiResponseModel
-        {
-            Code = code,
-            Message = message,
-            Data = data
-        };
-        
-        return Ok(response);
-    }
-    
-    protected IActionResult SuccessResponse(object? data = null)
-    {
-        return ApiResponse(200, "Success", data);
-    }
-    
-    protected IActionResult ErrorResponse(string message, int code = 400)
+    protected IActionResult OK<T>(ApiResponse<T> response)
     {
-        return ApiResponse(code, message);
+        return StatusCode(response.HttpStatus, response);
     }
 }

Controllers/UsersController.cs

@@ -9,7 +9,7 @@ namespace PaymentCoreServiceApi.Controllers;
 [ApiController]
 [Route("api/[controller]")]
 [Authorize]
-public class UsersController : BaseController
+public class UsersController : ControllerBaseCustom
 {
     private readonly IMediator _mediator;
 
@@ -23,17 +23,14 @@ public UsersController(IMediator mediator)
     public async Task<IActionResult> Create([FromBody] CreateUserCommand command)
     {
         var result = await _mediator.Send(command);
-        if (result == null)
-        {
-            return ErrorResponse("Username already exists");
-        }
-        return SuccessResponse(result);
+        return OK(result);
+
     }
 
     [HttpGet("profile")]
     public async Task<IActionResult> GetProfile()
     {
         var profile = await _mediator.Send(new GetUserProfileQuery());
-        return SuccessResponse(profile);
+        return OK(profile);
     }
 }

Core/Entities/BankAccountGenerated/BankAccountDto.cs

@@ -0,0 +1,13 @@
+namespace PaymentCoreServiceApi.Core.Entities.BankAccountGenerated;
+
+public class BankAccountDto
+{
+    public int Id { get; set; }
+    public int UserId { get; set; }
+    public string AccountNumber { get; set; } = string.Empty;
+    public decimal Balance { get; set; }
+    public string Currency { get; set; } = string.Empty;
+    public bool IsActive { get; set; }
+    public string? CreatedAt { get; set; }
+    public string? UpdatedAt { get; set; }
+}