Обработка исключений в API-контроллерах

controller.cs

[HttpPost]
public virtual ActionResult Create(ImportFeedReadModel model)
{
	if (!model.IsValid())
		return new HttpStatusCodeResult(HttpStatusCode.BadRequest);

	var service = new ImportFeedService(_importFileRepository, _estateSourceRepository);
	try
	{
		model.Id = service.CreateUserImportFile(UserIdentity.Id, UserIdentity.Name, model.Name, model.Url, model.Format);
		return Json(model);
	}
	catch (NotUniqueUrlException)
	{
		return Json(JsonErrorViewModel.NotUniqueUrlError());
	}
}

JsonErrorViewModel.cs

public class JsonErrorViewModel
{
	private JsonErrorViewModel(string error, dynamic parameters = null)
	{
		Error = error;
		Parameters = parameters;
	}

	public string Error { get; private set; }
	public dynamic Parameters { get; private set; }
  
  	// Static factory.
  	// If neeeded new error key, create new factory method.
	public static JsonErrorViewModel NotUniqueUrlError()
	{
		return new JsonErrorViewModel("NotUniqueUrlError");
	}
}

OnException.cs

protected override void OnException(ExceptionContext filterContext)
{
	filterContext.Result = new JsonResult { Data = filterContext.Exception.ToJsonObject(), JsonRequestBehavior = JsonRequestBehavior.AllowGet };
	filterContext.ExceptionHandled = true;
}

post.md

Если нужно как-то уведомить клиента об ошибке, бросаем типизированное исключение, ловим его в контроллере и возвращаем JSON-объект с полем Error, в котором записан "ключ" ошибки. Для этого создан класс JsonErrorViewModel:

JsonErrorViewModel.cs

Пример использования:

controller.cs

Если хочется отлавливать все unhandled exceptions контроллера и возвращать человечный JSON, в код контроллера нужно добавить:

OnException.cs