Jak zwrócić HTTP 500 z interfejsu API sieci Web ASP.NET Core RC2?

Wracając do RC1, zrobiłbym to:

[HttpPost]
public IActionResult Post([FromBody]string something)
{    
    try{
        // ...
    }
    catch(Exception e)
    {
         return new HttpStatusCodeResult((int)HttpStatusCode.InternalServerError);
    }
}

W RC2 nie ma już HttpStatusCodeResult i nie mogę znaleźć niczego, co pozwalałoby mi zwrócić 500 typów IActionResult.

Czy podejście, które teraz pytam, jest zupełnie inne? Czy już nie próbujemy złapać Controllerkodu? Czy zezwalamy po prostu, aby środowisko generowało ogólny wyjątek 500 z powrotem do programu wywołującego API? W jaki sposób mogę zobaczyć dokładny stos wyjątków?

Z tego, co widzę, istnieją metody pomocnicze w ControllerBaseklasie. Wystarczy użyć StatusCodemetody:

[HttpPost]
public IActionResult Post([FromBody] string something)
{    
    //...
    try
    {
        DoSomething();
    }
    catch(Exception e)
    {
         LogException(e);
         return StatusCode(500);
    }
}

Możesz także użyć StatusCode(int statusCode, object value)przeciążenia, które również negocjuje zawartość.

Możesz użyć Microsoft.AspNetCore.Mvc.ControllerBase.StatusCodei Microsoft.AspNetCore.Http.StatusCodessformułować swoją odpowiedź, jeśli nie chcesz zakodować określonych numerów.

return  StatusCode(StatusCodes.Status500InternalServerError);

AKTUALIZACJA: sierpień 2019

Być może nie związane bezpośrednio z pierwotnym pytaniem, ale próbując osiągnąć ten sam wynik Microsoft Azure Functions, stwierdziłem, że muszę zbudować nowy StatusCodeResultobiekt znaleziony w Microsoft.AspNetCore.Mvc.Corezestawie. Mój kod wygląda teraz tak;

return new StatusCodeResult(StatusCodes.Status500InternalServerError);

Jeśli potrzebujesz ciała w odpowiedzi, możesz zadzwonić

return StatusCode(StatusCodes.Status500InternalServerError, responseObject);

Zwróci to 500 z obiektem odpowiedzi ...

Lepszym sposobem radzenia sobie z tym już teraz (1,1) jest to zrobić w Startup.cs„s Configure():

app.UseExceptionHandler("/Error");

Spowoduje to wykonanie trasy dla /Error. Pozwoli ci to uniknąć dodawania bloków „try-catch” do każdej pisanej akcji.

Oczywiście musisz dodać ErrorController podobny do tego:

[Route("[controller]")]
public class ErrorController : Controller
{
    [Route("")]
    [AllowAnonymous]
    public IActionResult Get()
    {
        return StatusCode(StatusCodes.Status500InternalServerError);
    }
}

Więcej informacji tutaj .

Jeśli chcesz uzyskać rzeczywiste dane wyjątku, możesz dodać to do powyższego Get()tuż przed returninstrukcją.

// Get the details of the exception that occurred
var exceptionFeature = HttpContext.Features.Get<IExceptionHandlerPathFeature>();

if (exceptionFeature != null)
{
    // Get which route the exception occurred at
    string routeWhereExceptionOccurred = exceptionFeature.Path;

    // Get the exception that occurred
    Exception exceptionThatOccurred = exceptionFeature.Error;

    // TODO: Do something with the exception
    // Log it with Serilog?
    // Send an e-mail, text, fax, or carrier pidgeon?  Maybe all of the above?
    // Whatever you do, be careful to catch any exceptions, otherwise you'll end up with a blank page and throwing a 500
}

Powyżej fragmentu wzięty z bloga Scotta Saubera .

return StatusCode((int)HttpStatusCode.InternalServerError, e);

Powinien być używany w kontekstach innych niż ASP.NET (zobacz inne odpowiedzi dla ASP.NET Core).

HttpStatusCodejest wyliczeniem w System.Net.

Co powiesz na utworzenie niestandardowej klasy ObjectResult, która reprezentuje wewnętrzny błąd serwera, taki jak ten OkObjectResult? Możesz umieścić prostą metodę we własnej klasie bazowej, aby łatwo wygenerować InternalServerError i zwrócić ją tak jak ty Ok()lub BadRequest().

[Route("api/[controller]")]
[ApiController]
public class MyController : MyControllerBase
{
    [HttpGet]
    [Route("{key}")]
    public IActionResult Get(int key)
    {
        try
        {
            //do something that fails
        }
        catch (Exception e)
        {
            LogException(e);
            return InternalServerError();
        }
    }
}

public class MyControllerBase : ControllerBase
{
    public InternalServerErrorObjectResult InternalServerError()
    {
        return new InternalServerErrorObjectResult();
    }

    public InternalServerErrorObjectResult InternalServerError(object value)
    {
        return new InternalServerErrorObjectResult(value);
    }
}

public class InternalServerErrorObjectResult : ObjectResult
{
    public InternalServerErrorObjectResult(object value) : base(value)
    {
        StatusCode = StatusCodes.Status500InternalServerError;
    }

    public InternalServerErrorObjectResult() : this(null)
    {
        StatusCode = StatusCodes.Status500InternalServerError;
    }
}

Jeśli chcesz zwrócić odpowiedź JSON w MVC .Net Core Możesz również użyć:

Response.StatusCode = (int)HttpStatusCode.InternalServerError;//Equals to HTTPResponse 500
return Json(new { responseText = "my error" });

Zwróci zarówno wynik JSON, jak i HTTPStatus. Używam go do zwracania wyników do jQuery.ajax ().

W przypadku aspnetcore-3.1 można również użyć Problem()jak poniżej;

https://docs.microsoft.com/en-us/aspnet/core/web-api/handle-errors?view=aspnetcore-3.1

 [Route("/error-local-development")]
public IActionResult ErrorLocalDevelopment(
    [FromServices] IWebHostEnvironment webHostEnvironment)
{
    if (webHostEnvironment.EnvironmentName != "Development")
    {
        throw new InvalidOperationException(
            "This shouldn't be invoked in non-development environments.");
    }

    var context = HttpContext.Features.Get<IExceptionHandlerFeature>();

    return Problem(
        detail: context.Error.StackTrace,
        title: context.Error.Message);
}