forum

home / developersection / forums / how to catch all exceptions in web api 2?

Ask Question

How to catch all exceptions in Web API 2?

Anonymous User 2433 14-Jan-2015

I'm writing a RESTful API in Web API and I'm not sure how to handle errors effectively. I want the API to return JSON, and it needs to consist of the exact same format every single time - even on errors. Here are a couple of examples of what a successful and a failed response might look like.

Success:
{
    Status: 0,
    Message: "Success",
    Data: {...}
}
Error:
{
    Status: 1,
    Message: "An
error occurred!",
    Data: null
}

If there is an exception - any exception at all, I want to return a response that is formed like the second one. What is the foolproof way to do this, so that no exceptions are left unhandled?

asp.net c#  exception handling 
Updated on 14-Jan-2015
Anonymous User

Other

I am a content writter !

Message
Can you answer this question?
Answer

1 Answers

Manoj Bhatt

Manoj Bhatt

14-Jan-2015

Implement IExceptionHandler.

Something like:

public class APIErrorHandler : IExceptionHandler
{
    public Task HandleAsync(ExceptionHandlerContext
context, CancellationToken cancellationToken)
    {
        var jsonResult= Json.Encode(new 
                                {
                                    Message = new{ Message = context.Exception.Message }, 
                                    Status = ...
// whatever,
                                    Data = ... //
whatever
                                });
 
        context.Result= new ResponseMessageResult(new HttpResponseMessage { StatusCode = HttpStatusCode.InternalServerError,
Content = new StringContent(jsonResult) });
 
        return Task.FromResult(0);
    }
}

and in the configuration section of WebAPI (public static void Register(HttpConfiguration config)) write:

config.Services.Replace(typeof(IExceptionHandler), new APIErrorHandler());

MindStick Training
MindStick Training

Liked By

We use cookies to ensure you have the best browsing experience on our website. By using our site, you acknowledge that you have read and understood our Cookie Policy & Privacy Policy