在ASP.NET Core Web API 中處理文件下載

嘗試從ASP.NET Web API 控制器返回文件時，您可能會遇到以下問題：響應被視為JSON。要解決此問題，了解在 ASP.NET Core 中下載檔案的正確方法至關重要。

要在 ASP.NET Core Web API 中傳回文件，您需要傳回派生的 IActionResult 而不是 HttpResponseMessage。該框架會將 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 語句；否則，它將在發送回應之前被丟棄，從而導致異常或損壞的回應。當回應完成時，框架將自動處理流程處理。