How to return HTTP 500 from ASP.NET 5 Web Api?

Question

The controller now has function CreatedAtRoute() for 201, HttpBadRequest() for 400, etc. I don't see one for 500 which I figure would be HttpInternalServerError().

There is, however the HttpStatusCodeResult class which I can create and return:

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

But I want to return some info from e. This might be bad practice for live, but when we're testing, we'd like to see the errors from the returned body of the API call.

HttpStatusCodeResult does not have an property of type object or anything for the purpose of providing metadata.

What to do? I don't want to return a 400 because that's not what an Internal Server Error means.

I can't say for asp.net, but in many frameworks for Java there is often some type of HTTPResponse object that encapsulates both a response code and a response body. Might be something worth looking into. — CollinD
– CollinD, Commented Dec 10, 2015 at 16:04
Use the HttpStatusCodeResult(HttpStatusCode, String) overload to provide a description. As far as passing an object, you're right--you can't. But that's per the protocol. — Brad Christie
– Brad Christie, Commented Dec 10, 2015 at 16:05
@CollinD - there doesn't seem to be a constructor with that second string parameter. I might be missing a reference to an extension. — Mickael Caruso
– Mickael Caruso, Commented Dec 10, 2015 at 16:12

Thiago Custodio · Accepted Answer · 2015-12-10 16:08:00Z

5

return ResponseMessage(Request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Message describing the error here"));

or

return InternalServerError(new Exception("SOME CUSTOM MESSAGE"));

answered Dec 10, 2015 at 16:08

Thiago Custodio

18.4k9 gold badges50 silver badges99 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

abatishchev Over a year ago

I would to the later, since it's a Web Api 2.x approach.

Collectives™ on Stack Overflow

How to return HTTP 500 from ASP.NET 5 Web Api?

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related