Renvoyer le fichier dans l'API Web ASP.Net Core

Problème

Je souhaite renvoyer un fichier dans mon contrôleur d'API Web ASP.Net, mais toutes mes approches renvoient le HttpResponseMessagesous forme de JSON.

Code jusqu'à présent

public async Task<HttpResponseMessage> DownloadAsync(string id)
{
    var response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = new StreamContent({{__insert_stream_here__}});
    response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
    return response;
}

Lorsque j'appelle ce point de terminaison dans mon navigateur, l'API Web renvoie le en HttpResponseMessagetant que JSON avec l'en-tête de contenu HTTP défini sur application/json.

S'il s'agit d'ASP.net-Core, vous mélangez des versions d'API Web. Demandez à l'action de renvoyer un dérivé IActionResultcar dans votre code actuel, le framework est traité HttpResponseMessagecomme un modèle.

[Route("api/[controller]")]
public class DownloadController : Controller {
    //GET api/download/12345abc
    [HttpGet("{id}"]
    public async Task<IActionResult> Download(string id) {
        Stream stream = await {{__get_stream_based_on_id_here__}}

        if(stream == null)
            return NotFound(); // returns a NotFoundResult with Status404NotFound response.

        return File(stream, "application/octet-stream"); // returns a FileStreamResult
    }    
}

Vous pouvez retourner FileResult avec ces méthodes:

1: Renvoyer FileStreamResult

    [HttpGet("get-file-stream/{id}"]
    public async Task<FileStreamResult> DownloadAsync(string id)
    {
        var fileName="myfileName.txt";
        var mimeType="application/...."; 
        var stream = await GetFileStreamById(id);

        return new FileStreamResult(stream, mimeType)
        {
            FileDownloadName = fileName
        };
    }

2: Renvoyer FileContentResult

    [HttpGet("get-file-content/{id}"]
    public async Task<FileContentResult> DownloadAsync(string id)
    {
        var fileName="myfileName.txt";
        var mimeType="application/...."; 
        var fileBytes = await GetFileBytesById(id);

        return new FileContentResult(fileBytes, mimeType)
        {
            FileDownloadName = fileName
        };
    }

Voici un exemple simpliste de streaming d'un fichier:

using System.IO;
using Microsoft.AspNetCore.Mvc;

[HttpGet("{id}")]
public async Task<FileStreamResult> Download(int id)
{
    var path = "<Get the file path using the ID>";
    var stream = File.OpenRead(path);
    return new FileStreamResult(stream, "application/octet-stream");
}

Remarque:

Assurez-vous d'utiliser FileStreamResultde Microsoft.AspNetCore.Mvcet non de System.Web.Mvc.