ASP.NET Core Web API でのファイル ダウンロードの処理

ASP.NET Web API コントローラーからファイルを返そうとすると、応答は JSON として扱われます。これを解決するには、ASP.NET Core でファイルをダウンロードするための正しいアプローチを理解することが重要です。

ASP.NET Core Web API でファイルを返すには、HttpResponseMessage の代わりに派生した IActionResult を返す必要があります。フレームワークは HttpResponseMessage をモデルとして解釈し、JSON 応答の問題を引き起こします。

以下は、IActionResult:

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

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

        return File(stream, "application/octet-stream", $"{FileName}.{FileExtension}"); // Returns a FileStreamResult
    }
}

注: ストリームに対して using ステートメントを使用しないでください。そうしないと、応答が送信される前に破棄され、例外または破損した応答が発生します。フレームワークは、応答が完了するとストリームの破棄を自動的に処理します。