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?
Manoj Bhatt
14-Jan-2015Implement IExceptionHandler.
Something like:
and in the configuration section of WebAPI (public static void Register(HttpConfiguration config)) write:
config.Services.Replace(typeof(IExceptionHandler), new APIErrorHandler());