BitzArt.ApiExceptions.AspNetCore 1.21.0

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package BitzArt.ApiExceptions.AspNetCore --version 1.21.0                

                    
                

            
NuGet\Install-Package BitzArt.ApiExceptions.AspNetCore -Version 1.21.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="BitzArt.ApiExceptions.AspNetCore" Version="1.21.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add BitzArt.ApiExceptions.AspNetCore --version 1.21.0                

                    
                

            
#r "nuget: BitzArt.ApiExceptions.AspNetCore, 1.21.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install BitzArt.ApiExceptions.AspNetCore as a Cake Addin
#addin nuget:?package=BitzArt.ApiExceptions.AspNetCore&version=1.21.0

// Install BitzArt.ApiExceptions.AspNetCore as a Cake Tool
#tool nuget:?package=BitzArt.ApiExceptions.AspNetCore&version=1.21.0

Tests

General

This library defines ApiExceptions that you can throw in your .Net applications.

Use with Asp.Net Core

💡 You can always refer to this sample project for guidance.

Setup:

Add the nuget package:

dotnet add package BitzArt.ApiExceptions.AspNetCore

Add this line to your Program.cs when configuring services:

builder.Services.AddApiExceptionHandler();

Add this line to your Program.cs when configuring the request pipeline:

// This line should go before any other middleware that might throw exceptions
app.UseApiExceptionHandler();

Usage:

Then, anywhere in your code, you can throw exceptions like:

throw ApiException.NotFound("sample 'not found' message");

This will generate an http response with appropriate status code:

404-screenshot

Extra:

You can also add any custom fields:

anonymous-screenshot

These responses follow RFC7807: Problem Details standard.

Use outside of Asp.Net Core

To use ApiExceptions in your applications, add this nuget package to your project:

dotnet add package BitzArt.ApiExceptions

This will allow you to use ApiExceptions, and you can then handle them as you see fit.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on BitzArt.ApiExceptions.AspNetCore:

Package Downloads
OCPI.Net.Exceptions

Defines exception classes for OCPI.Net
BitzArt.CA.Infrastructure.AspNetCore

Clean Architecture boilerplate. Infrastructure package for Asp.Net Core

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.22.0 3,808 4/2/2024
1.21.2 129 4/2/2024
1.21.1 614 3/18/2024
1.21.0 138 3/18/2024
1.20.0 2,636 2/27/2024
1.19.0 469 1/30/2024
1.18.2 4,867 9/5/2023
1.18.1 545 9/5/2023
1.18.0 561 9/5/2023
1.17.1 718 8/18/2023
1.17.0 603 8/18/2023
1.16.0 783 8/14/2023
1.15.0 626 8/14/2023
1.14.1 606 8/10/2023
1.14.0 743 8/10/2023
1.13.0 656 8/10/2023
1.12.1 3,064 2/9/2023