How to return a custom HTTP status/message in ASP.NET Core without returning object, IActionResult, etc?

Question

I have an ASP.NET Core Web API site, with Swagger generation and UI enabled. In order for Swagger to work (at least work automatically), the return value from the controller method must be typed. For example,

public async Task<Employee> LoadEmployee(string id)

However, I need to return custom HTTP status codes and content from this action. All the examples I've seen use the StatusCode method, or return some other object. The problem with this is then Swagger doesn't know what the return type of the action is, and so can't generate the API spec.

Is there some way (Exception, methods on controller, etc) to return the custom code/content, while keeping the signature? I've seen solutions using custom middleware, but it seems like a common enough scenario that there should be something built it.

Nkosi · Accepted Answer · 2017-11-12 12:27:18Z

9

You can just use StatusCodeResult StatusCode(...) to return status code and a message/object.

public async Task<ObjectResult> LoadEmployee(string id)
{
    var employee = await repository.GetById(id);
    if(employee == null) {
        return NotFound();
    }

    return StatusCode((int)HttpStatusCode.Ok, employee);
}

edited Nov 12, 2017 at 12:27

Nkosi

249k38 gold badges472 silver badges506 bronze badges

answered Apr 8, 2017 at 16:25

Ansar

2062 silver badges5 bronze badges

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

1 Comment

Nick Kovalsky Over a year ago

not working in Api, has just 1 parameter for status and cannot pass employee

Nkosi · Accepted Answer · 2016-11-24 00:08:12Z

3

references:

ASP.NET Core APIs in the fast lane with Swagger and Autorest

Adding swagger in ASP.NET Core Web API

ASP.NET Core 1.0 MVC API documentation using Swashbuckle Swagger

For output definition, just add the [Produces] and [SwaggerResponse] attributes describing the Type returned, like this:

[HttpGet]
[Produces(typeof(Employee))]
[SwaggerResponse(System.Net.HttpStatusCode.OK, Type = typeof(Employee))]
public async Task<IActionResult> LoadEmployee(string id) {
    var employee = await repository.GetById(id);
    if(employee == null) {
        return NotFound();
    }
    return Ok(employee);
}

answered Nov 24, 2016 at 0:08

Nkosi

249k38 gold badges472 silver badges506 bronze badges

1 Comment

Erick T Over a year ago

Thanks. I was hoping to avoid swagger specific code (as opposed to the API being mainly self documented) but this works.

Nkosi · Accepted Answer · 2017-11-12 12:26:16Z

1

ProducesResponseType attribute is supported by Swagger and is a MVC Web API Core attribute, not Swagger. Does the same as SwaggerResponse.

edited Nov 12, 2017 at 12:26

Nkosi

249k38 gold badges472 silver badges506 bronze badges

answered Mar 9, 2017 at 6:59

Cleverguy25

5034 silver badges14 bronze badges

Collectives™ on Stack Overflow

How to return a custom HTTP status/message in ASP.NET Core without returning object, IActionResult, etc?

3 Answers 3

1 Comment

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related