首页  >  文章  >  后端开发  >  如何从 ASP.NET Core Web API 控制器返回文件?

如何从 ASP.NET Core Web API 控制器返回文件?

Barbara Streisand
Barbara Streisand原创
2024-11-01 04:14:02187浏览

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