ResponseType in ASP.NET Core

Question

I just moved my project to ASP.Net Core from ASP.Net 4.5. I've a REST API get that used to return a blob but now is returning JSON instead.

This is the old code:

[HttpGet]
[ResponseType(typeof(HttpResponseMessage))]
[Route("Download/{documentId}")]
public async Task<HttpResponseMessage> DownloadDocument(string documentId)
{
    try
    {
        var result = await TheDocumentService.DownloadDocument(documentId);

        return result;
    }
    catch (Exception ex)
    {
        return new HttpResponseMessage
        {
            StatusCode = HttpStatusCode.InternalServerError,
            Content = new StringContent(ex.Message)
        };
    }
}

The code in ASP.net Core is the same except for [ResponseType(typeof(HttpResponseMessage))] not working in ASP.Net Core, also the return result is also the same in both solutions.

But when looking at the response from the server in the client they differ.

So the only thing that differs them both from each other are the [ResponseType(typeof(HttpResponseMessage))]. Is there something equivalent in asp.net core?

Do you have [Produces("application/json")] at the top of your controller? — SBFrancies
– SBFrancies, Commented Jan 18, 2018 at 10:02
@SBFrancies nope only [HttpGet] [Route("Download/{documentId}")] — President Camacho
– President Camacho, Commented Jan 18, 2018 at 10:03
The answers to this question might help you: stackoverflow.com/questions/42460198/… — SBFrancies
– SBFrancies, Commented Jan 18, 2018 at 11:33

Venkatesh Muniyandi · Accepted Answer · 2021-10-16 01:32:14Z

8

Dot Net Core equivalent to [ResponseType(typeof(HttpResponseMessage))] is [Produces(typeof(HttpResponseMessage))]

answered Oct 16, 2021 at 1:32

Venkatesh Muniyandi

5,7312 gold badges43 silver badges48 bronze badges

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

1 Comment

Jeremy Lakeman Over a year ago

Produces is useful for swagger docs, but the api response OP wants is either a file stream or 500 error, not a json serialisation of HttpResponseMessage.

Nkosi · Accepted Answer · 2018-03-02 17:35:26Z

1

How to to return an image with Web API Get method

I solved it by changing my return:

[HttpGet]
[Route("Download/{documentId}")]
public async Task<IActionResult> DownloadDocument(string documentId)
{
    try
    {
        var result = await TheDocumentService.DownloadDocument(documentId);
        var content = await result.Content.ReadAsByteArrayAsync();
        return File(content, result.Content.Headers.ContentType.ToString());
    }
    catch (Exception ex)
    {
        return StatusCode(500, ex);
    }
}

edited Mar 2, 2018 at 17:35

Nkosi

249k38 gold badges472 silver badges506 bronze badges

answered Jan 18, 2018 at 12:01

President Camacho

1,9407 gold badges27 silver badges47 bronze badges

1 Comment

Chris Pratt Over a year ago

Do not block on async methods by accessing Result. That's an excellent way to deadlock your application. Always use await, which you can do inline if that's your goal, i.e. return File(await result.Content.ReadAsByteArrayAsync()....

KarMau · Accepted Answer · 2021-11-11 00:19:28Z

0

Edit: @President Camacho said that [ResponseType...] would not work in .net core. It has been replaced by [ProducesResponseType]:

[HttpGet]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<int>))]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult<IEnumerable<User>>> Get...()

The explanation from Microsoft is fine: https://learn.microsoft.com/en-us/aspnet/core/web-api/action-return-types?view=aspnetcore-6.0#iactionresult-type A quote from the website sums it up: "This attribute produces more descriptive response details for web API help pages generated by tools like Swagger."

And it's good for other team members who don't want to look at the source code to develop the UI.

edited Nov 11, 2021 at 0:19

answered Nov 9, 2021 at 0:03

KarMau

235 bronze badges

3 Comments

Jeremy Caney Over a year ago

Can you offer an explanation of what the [ProducesResponseType()] attribute does, and why you prefer this syntax over that offered in e.g., @President Camacho answer from a few years ago?

KarMau Over a year ago

The explanation from Microsoft is fine: learn.microsoft.com/en-us/aspnet/core/web-api/… - A quote from the website: "This attribute produces more descriptive response details for web API help pages generated by tools like Swagger." And it's good for other team members who don't want to look at the source code to develop the UI.

KarMau Over a year ago

And the questioner said that ResponseType ... would not work in .net core. The reference to ProducesResponseType is at least part of the answer.

Collectives™ on Stack Overflow

ResponseType in ASP.NET Core

3 Answers 3

1 Comment

1 Comment

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

1 Comment

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related