Franz.Common.Errors 1.2.62

Franz.Common.Errors

A library for handling and standardizing errors and exceptions in .NET applications. This library simplifies error management, making it easier to implement structured and meaningful error responses.

Features

• Custom Exceptions:
  • ForbiddenException
  • FunctionalException
  • NotFoundException
  • PreconditionFailedException
  • TechnicalException
  • UnauthorizedException
• Base Exception:
  • ExceptionBase for creating custom exceptions with consistent behavior.
• Error Response:
  • ErrorResponse for structuring API error responses.

Installation

Install the package using NuGet Package Manager or the .NET CLI:

dotnet add package Franz.Common.Errors

Usage

1. Handling Custom Exceptions

Each exception is tailored for specific error scenarios. Here's an example of using NotFoundException:

using Franz.Common.Errors;

public void FindResource(int id)
{
    var resource = GetResourceById(id);
    if (resource == null)
    {
        throw new NotFoundException($"Resource with ID {id} was not found.");
    }
}

2. Returning Structured Error Responses

Use ErrorResponse to provide consistent error information in your APIs:

using Franz.Common.Errors;

public IActionResult HandleException(Exception ex)
{
    var errorResponse = new ErrorResponse
    {
        StatusCode = 500,
        Message = ex.Message,
        Details = "Additional details about the error."
    };

    return StatusCode(errorResponse.StatusCode, errorResponse);
}

3. Creating Custom Exceptions

Extend the ExceptionBase class to create your own exceptions with additional metadata:

using Franz.Common.Errors;

public class CustomException : ExceptionBase
{
    public CustomException(string message) : base(message) { }
}

Exception Types Overview

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Submit a pull request for review.

License

This library is licensed under the MIT License. See the LICENSE file for more details.