首頁  >  文章  >  後端開發  >  如何從 ASP.NET Core Web API 控制器傳回檔案?

如何從 ASP.NET Core Web API 控制器傳回檔案?

Barbara Streisand
Barbara Streisand原創
2024-11-01 04:14:02192瀏覽

How to Return Files from an ASP.NET Core Web API Controller?

在ASP.NET Core Web API 中處理檔案下載

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

要在 ASP.NET Core Web API 中傳回文件,您需要傳回派生的 IActionResult 而不是 HttpResponseMessage。框架會將 HttpResponseMessage 解釋為模型,導致 JSON 回應問題。

以下是更新的程式碼範例,示範如何使用IActionResult 回傳檔案:

<code class="csharp">[Route("api/[controller]")]
public class DownloadController : Controller
{
    // GET api/download/12345abc
    [HttpGet("{id}")]
    public async Task<IActionResult> 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
    }
}</code>

注意: 不要對串流使用using 語句;否則,它將在傳送回應之前被丟棄,從而導致異常或損壞的響應。當回應完成時,框架將自動處理流程處理。

以上是如何從 ASP.NET Core Web API 控制器傳回檔案?的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn