Restituzione degli errori JSON dall'API Asp.Net MVC 6

Question

Sto provando a creare un'API Web con MVC 6. Tuttavia, quando uno dei metodi del controller genera un errore, il contenuto della risposta è una pagina HTML formattata in modo molto gradevole che sarebbe molto istruttivo se questa fosse un'app MVC. Ma dal momento che questa è un'API, preferirei piuttosto restituire un JSON.

Nota: La mia configurazione è super semplice in questo momento, appena impostazione:

app.UseStaticFiles(); 
    app.UseIdentity(); 

    // Add MVC to the request pipeline. 
    app.UseMvc(); 

Voglio impostare questa funzione universalmente. Esiste un modo "giusto/migliore" per configurarlo in MVC 6 per un'API?

Grazie ...

Answer 1

Un modo per raggiungere lo scenario è quello di scrivere un ExceptionFilter e che catturano i dettagli necessari e impostare il Result per essere un JsonResult.

// Here I am creating an attribute so that you can use it on specific controllers/actions if you want to. 
public class CustomExceptionFilterAttribute : ExceptionFilterAttribute 
{ 
    public override void OnException(ExceptionContext context) 
    { 
     var exception = context.Exception; 
     context.Result = new JsonResult(/*Your POCO type having necessary details*/) 
     { 
      StatusCode = (int)HttpStatusCode.InternalServerError 
     }; 
    } 
} 

È possibile aggiungere questo filtro di eccezione per essere applicabile a tutti i controller. Esempio:

app.UseServices(services => 
{ 
    services.AddMvc(); 
    services.Configure<MvcOptions>(options => 
    { 
     options.Filters.Add(new CustomExceptionFilterAttribute()); 
    }); 
..... 
} 

Si noti che questa soluzione non copre tutti gli scenari ... per esempio, quando viene generata un'eccezione durante la scrittura la risposta da un formattatore.