AdaskoTheBeAsT.Owin.SecureExceptions
1.1.0
dotnet add package AdaskoTheBeAsT.Owin.SecureExceptions --version 1.1.0
NuGet\Install-Package AdaskoTheBeAsT.Owin.SecureExceptions -Version 1.1.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="AdaskoTheBeAsT.Owin.SecureExceptions" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AdaskoTheBeAsT.Owin.SecureExceptions --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AdaskoTheBeAsT.Owin.SecureExceptions, 1.1.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 AdaskoTheBeAsT.Owin.SecureExceptions as a Cake Addin
#addin nuget:?package=AdaskoTheBeAsT.Owin.SecureExceptions&version=1.1.0
// Install AdaskoTheBeAsT.Owin.SecureExceptions as a Cake Tool
#tool nuget:?package=AdaskoTheBeAsT.Owin.SecureExceptions&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
AdaskoTheBeAsT.Owin.SecureExceptions
Secure exceptions for Owin based on OwinFriendlyExceptions and OwinFriendlyExceptions.Plugins. A middleware that can translate exceptions into nice http resonses. This allows you to throw meaningfull exceptions from your framework, business code or other middlewares and translate the exceptions to nice and friendly http responses.
Installation
Install-package AdaskoTheBeAsT.Owin.SecureExceptions
See Troubleshooting for help with any installation errors
Example
using System;
using System.Net;
using Api.Exceptions;
using Api.Logic.Exceptions;
using Owin;
using AdaskoTheBeAsT.Owin.SecureExceptions;
using AdaskoTheBeAsT.Owin.SecureExceptions.Extensions;
using AdaskoTheBeAsT.Owin.SecureExceptions.WebApi2;
namespace Api
{
public class Startup
{
public void Configuration(IAppBuilder app)
{
// Use AdaskoTheBeAsT.Owin.SecureExceptions before your other middlewares
app.UseSecureExceptions(GetSecureExceptions(), new [] {new WebApi2ExceptionProvider()});
// Then the rest of your application
//app.UseCors(options);
//app.UseWelcomePage();
//app.UseWebApi(config)
}
private ITransformsCollection GetSecureExceptions()
{
return TransformsCollectionBuilder.Begin()
.Map<ExampleException>()
.To(HttpStatusCode.BadRequest, "This is the reasonphrase",
ex => "And this is the response content: " + ex.Message)
.Map<SomeCustomException>()
.To(HttpStatusCode.NoContent, "Bucket is emtpy", ex => string.Format("Inner details: {0}", ex.Message))
.Map<EntityUnknownException>()
.To(HttpStatusCode.NotFound, "Entity does not exist", ex => ex.Message)
.Map<InvalidAuthenticationException>()
.To(HttpStatusCode.Unauthorized, "Invalid authentication", ex => ex.Message)
.Map<AuthorizationException>()
.To(HttpStatusCode.Forbidden, "Forbidden", ex => ex.Message)
// Map all other exceptions if needed.
// Also it would be useful if you want to map exception to a known model.
.MapAllOthers()
.To(HttpStatusCode.InternalServerError, "Internal Server Error", ex => ex.Message)
.Done();
}
}
}
Specify content type
By default, AdaskoTheBeAsT.Owin.SecureExceptions sets the response Content-Type to text/plain. To use a different type:
.Map<SomeJsonException>()
.To(HttpStatusCode.BadRequest, "This exception is json",
ex => JsonConvert.SerializeObject(ex.Message), "application/json")
WebApi2
Installation:
Install-package AdaskoTheBeAsT.Owin.SecureExceptionsapp.UseFriendlyExceptions(exceptionsToHandle, new [] {new WebApi2ExceptionProvider()});config.Services.Replace(typeof(IExceptionHandler), new WebApi2ExceptionHandler(exceptionsToHandle));Install the package, and supply the WebApi Exception Provider to the AdaskoTheBeAsT.Owin.SecureExceptions extension method. In order for the Plugin to get swallowed exceptions you have to replace the ExcepionHandler service in Web Api. The plugin takes a list of which exceptions we can handle, so WebApi can still take care of unhandled exceptions for you.
Troubleshooting
When installing the Web Api Plugin, sometimes your System.Web.Http reference will mismatch. Use this Package Manager Console command to fix your Assembly Bining redirect: Get-Project YourProjectReferencingOwinFriendlyExceptions | Add-BindingRedirect
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET Framework | net462 is compatible. net463 was computed. net47 is compatible. net471 is compatible. net472 is compatible. net48 is compatible. net481 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 4.6.2
- Microsoft.AspNet.WebApi.Owin (>= 5.3.0)
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.7
- Microsoft.AspNet.WebApi.Owin (>= 5.3.0)
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.7.1
- Microsoft.AspNet.WebApi.Owin (>= 5.3.0)
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.7.2
- Microsoft.AspNet.WebApi.Owin (>= 5.3.0)
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.8
- Microsoft.AspNet.WebApi.Owin (>= 5.3.0)
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.8.1
- Microsoft.AspNet.WebApi.Owin (>= 5.3.0)
- Newtonsoft.Json (>= 13.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
- initial release