[FEAT] Return coded error messages

[aspirio187]

Is your feature request related to a problem? Please describe.

On the API consumer's point of view, it is more difficult to handle the errors

Describe the solution you'd like

Add some codes with error messages predefined making it easier for the consumer to analyze where and what his error is

Describe alternatives you've considered

...

Additional context

...

[samadh90]

To address this issue, the solution proposed is to add some codes with error messages predefined, which would make it easier for the consumer to analyze where and what his error is.

One alternative to this solution could be to provide more comprehensive documentation on how to handle errors and what error codes and messages to expect. This could include examples and explanations of common error scenarios and how to handle them.

Another alternative could be to provide additional tools or resources for API consumers to help them troubleshoot and diagnose errors. For example, providing a log file or diagnostic dashboard that shows recent API requests and responses, error codes and messages, and other relevant information could help consumers quickly identify and address errors.

Overall, there are multiple approaches to addressing the difficulty in handling errors on the API consumer's point of view. The most appropriate solution will depend on the specific requirements and constraints of the API and the needs of the API consumers.

[HttpGet]
public async Task<IActionResult> Get()
{
    try
    {
        // Code to fetch data from database or other source
        var result = await _repository.GetData();
        return Ok(result);
    }
    catch (Exception ex)
    {
        // Log the error message
        _logger.LogError(ex, "An error occurred while fetching data.");

        // Return a standardized error response
        return StatusCode(StatusCodes.Status500InternalServerError, new ErrorResponse
        {
            Code = "InternalError",
            Message = "An internal error occurred while fetching data. Please try again later.",
            Details = ex.Message
        });
    }
}

In this example, we have a GET method that fetches data from a repository. If an exception occurs during this operation, we catch it and log the error message using a logger. We then return a standardized error response with a 500 status code, along with an error code, message, and details about the error.

The ErrorResponse class could be defined as follows:

public class ErrorResponse
{
    public string Code { get; set; }
    public string Message { get; set; }
    public string Details { get; set; }
}

This class contains properties for an error code, message, and details. By returning a standardized error response with a consistent format and structure, we make it easier for API consumers to understand and handle errors.