调用返回HttpResponseMessage的API无法下载文件，返回JSON响应

代码中的核心问题及修正 #

你的代码存在几个明显问题，导致无法正确触发文件下载：

1. FileStream初始化错误
   原代码中var dataBytes = FileStream(filePath, FileMode.Open, FileAccess.Read);缺少new关键字，且不能直接将FileStream传入MemoryStream构造函数。实际上无需转成MemoryStream，直接使用FileStream即可。
2. 未定义的变量bookName
   代码中直接使用bookName但未声明赋值，会导致编译失败，需替换为实际的文件名（比如从id关联获取对应文件名）。
3. 响应处理的潜在适配问题
   在部分Web API版本或配置下，直接返回HttpResponseMessage可能被框架意外序列化，改用更贴合框架设计的返回类型能规避这类问题。

修正后的代码（ASP.NET Web API 传统版本） #

[HttpGet]
[Route("Download")]
public HttpResponseMessage GetBookForHRM(string id)
{
    // 根据id获取实际文件路径和文件名，示例为硬编码
    string filePath = "path/to/your/file.txt";
    string bookName = "target-book-name.txt";

    // 直接使用FileStream，无需转MemoryStream
    var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read);

    HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.OK);
    response.Content = new StreamContent(fileStream);
    
    response.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
    {
        FileName = bookName
    };
    response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/octet-stream");
    response.Content.Headers.ContentLength = fileStream.Length;

    return response;
}

修正后的代码（ASP.NET Core 版本） #

如果是ASP.NET Core环境，推荐使用框架原生的FileResult，写法更简洁且不易出错：

[HttpGet]
[Route("Download")]
public IActionResult GetBookForHRM(string id)
{
    string filePath = "path/to/your/file.txt";
    string bookName = "target-book-name.txt";

    return File(new FileStream(filePath, FileMode.Open, FileAccess.Read), 
                "application/octet-stream", 
                bookName);
}

客户端调用关键注意事项 #

如果API代码修正后仍返回JSON，大概率是客户端调用方式错误：

• 不能用AJAX、fetch等异步调用方式，这类调用仅会接收响应内容，不会触发浏览器的下载弹窗。
• 必须通过直接导航触发：比如使用<a href="/api/your-controller/Download?id=xxx">下载文件</a>，或者通过window.open("/api/your-controller/Download?id=xxx")触发跳转。

内容的提问来源于stack exchange，提问作者Anuj