How to download file with Swagger UI

user_7932025 0
Viewed 19135

I have rest controller which is returning HttpResponseMessage with Stream file as a content, something like this:

public class MyController : ApiController
{
    public HttpResponseMessage GetFile(string id)
    {
        try { 
            var stream = fileSystemUtils.GetFileStream(filePath); //Get Stream
            HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
            response.Content = stream;
            return response;
        }
        catch (FileNotFoundException)
        {
            return new HttpResponseMessage(HttpStatusCode.NotFound);
        }
    }
}

When i call this method by ULR in browser everything is ok and i can download this file. Now i would like to download it using Swagger UI. Is some easy way to do this?

swagger asp.net-web-api c#
3 Answers

This is what worked for me (.Net Core 2.2 and Swashbuckle 4.0.1):

[Route("api/[controller]")]
[ApiController]
public class DownloadController : ControllerBase
{
    [HttpGet("{name}")]
    [ProducesResponseType(typeof(byte[]), StatusCodes.Status200OK)]
    [ProducesResponseType(typeof(BadRequestObjectResult), 400)]
    public async Task<IActionResult> GetFile(string fileName)
    {
        var filePath = $"files/{fileName}"; // get file full path based on file name
        if (!System.IO.File.Exists(filePath))
        {
            return BadRequest();
        }
        return File(await System.IO.File.ReadAllBytesAsync(filePath), "application/octet-stream", fileName);
    }
}
user_46951590

Little bit late, but the correct way to do it is to use the Content-Disposition header and set the attachment flag. For example:

Content-Disposition: attachment; filename=myfile.xxx

Will indicate that it's an attachment. It's not required to set the Content-Type but it's a good practice to do so.

More info in this stack overflow question:

Do I need Content-Type: application/octet-stream for file download?

user_2417500
Related