Как вернуть HTTP 500 из ASP.NET Core RC2 Web Api?

Вернувшись в RC1, я бы сделал это:

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

В RC2 больше нет HttpStatusCodeResult, и я не могу найти ничего, что позволило бы мне возвращать тип 500 типа IActionResult.

Подход сейчас совершенно другой для того, что я спрашиваю? Разве мы больше не пытаемся поймать Controllerкод? Мы просто позволяем фреймворку генерировать общее исключение 500 обратно в вызывающую функцию API? Для разработки, как я могу увидеть точный стек исключений?

Из того, что я вижу, внутри ControllerBaseкласса есть вспомогательные методы . Просто используйте StatusCodeметод:

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

Вы также можете использовать StatusCode(int statusCode, object value)перегрузку, которая также согласовывает содержимое.

Вы можете использовать Microsoft.AspNetCore.Mvc.ControllerBase.StatusCodeи Microsoft.AspNetCore.Http.StatusCodesдля формирования своего ответа, если вы не хотите жестко задавать конкретные номера.

return  StatusCode(StatusCodes.Status500InternalServerError);

ОБНОВЛЕНИЕ: август 2019

Возможно, это не имеет прямого отношения к исходному вопросу, но, пытаясь достичь того же результата, Microsoft Azure Functionsя обнаружил, что мне нужно создать новый StatusCodeResultобъект, найденный в Microsoft.AspNetCore.Mvc.Coreсборке. Мой код теперь выглядит так;

return new StatusCodeResult(StatusCodes.Status500InternalServerError);

Если вам нужно тело в вашем ответе, вы можете позвонить

return StatusCode(StatusCodes.Status500InternalServerError, responseObject);

Это вернет 500 с объектом ответа ...

Лучший способ справиться с этим , как сейчас (1.1) , чтобы сделать это в Startup.cs«s Configure():

app.UseExceptionHandler("/Error");

Это выполнит маршрут для /Error. Это избавит вас от добавления блоков try-catch к каждому написанному вами действию.

Конечно, вам нужно добавить ErrorController, похожий на этот:

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

Больше информации здесь .

Если вы хотите получить фактические данные об исключениях, вы можете добавить их к вышеприведенному Get()прямо перед returnоператором.

// 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
}

Выше фрагмент взят из блога Скотта Саубера .

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

Должен использоваться в не-ASP.NET контекстах (см. Другие ответы для ASP.NET Core).

HttpStatusCodeперечисление в System.Net.

Как насчет создания пользовательского класса ObjectResult, который представляет внутреннюю ошибку сервера, такую ​​как для OkObjectResult? Вы можете поставить простой метод в вашем собственном базовом классе , так что вы можете легко сгенерировать InternalServerError и вернуть его так же , как вы делаете Ok()или 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;
    }
}

Если вы хотите вернуть ответ JSON в MVC .Net Core, вы также можете использовать:

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

Это вернет как JSON-результат, так и HTTPStatus. Я использую его для возврата результатов в jQuery.ajax ().

Для aspnetcore-3.1 вы также можете использовать, Problem()как показано ниже;

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);
}