Returning binary data with web api

Question

I have the following controller method which returns a byte array.

    public async Task<HttpResponseMessage> Get()
    {
        var model = new byte[] { 1, 2, 3 };

        HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK);
        result.Content = new StreamContent(new MemoryStream(model));
        result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
        return result;
    }

I think this is an older way of implementing this functionality with web api. Is there a more "modern" version?

For example, is returning a Task<IHttpActionResult> the preferred way now? And if so, what would be the code to return the byte array from above?

I do not believe there is any new way to handle this. Web API 2 has not changed. I see there is no await inside your method, for this reason you should avoid making it async, just use HttpResponseMessage as return type. — Federico Dipuma
– Federico Dipuma, Commented May 13, 2017 at 11:57

peco · Accepted Answer · 2017-05-15 07:58:49Z

5

As the comment pointed out. I dont think there is a new way to do this. But if you would like to return an IHttpActionResult instead, there is a base method that returns a ResponseMessageResult:

public IHttpActionResult Get()
{
    var model = new byte[] { 1, 2, 3 };

    var result = new HttpResponseMessage(HttpStatusCode.OK)
    {
        Content = new StreamContent(new MemoryStream(model))
    };
    result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
    return ResponseMessage(result);
}

answered May 15, 2017 at 7:58

peco

4,0001 gold badge23 silver badges27 bronze badges

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

Comments

Aycox · Accepted Answer · 2017-11-24 14:34:43Z

5

Also, to return binary data in AspNetCore WebApi2 if anyone needs it:

[Route("api/v1/export/excel")]
[HttpGet]
public IActionResult GetAsExcel()
{
    var exportStream = new MemoryStream();
    _exportService.ExportAllToExcel(exportStream);
    // Rewind the stream before we send it.
    exportStream.Position = 0;
    return new FileStreamResult(exportStream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
}

answered Nov 24, 2017 at 14:34

Aycox

1362 silver badges7 bronze badges

Collectives™ on Stack Overflow

Returning binary data with web api

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related