Como definir o download do nome do arquivo na API da Web do ASP.NET

Na minha classe ApiController, tenho o seguinte método para baixar um arquivo criado pelo servidor.

public HttpResponseMessage Get(int id)
{
    try
    {
        string dir = HttpContext.Current.Server.MapPath("~"); //location of the template file
        Stream file = new MemoryStream();
        Stream result = _service.GetMyForm(id, dir, file);
        if (result == null)
        {
            return Request.CreateResponse(HttpStatusCode.NotFound);
        }
        result.Position = 0;
        HttpResponseMessage response = new HttpResponseMessage();
        response.StatusCode = HttpStatusCode.OK;
        response.Content = new StreamContent(result);
        return response;
    }
    catch (IOException)
    {
        return Request.CreateResponse(HttpStatusCode.InternalServerError);
    }
}

Tudo está funcionando perfeitamente, exceto que o nome do arquivo de download padrão é o seu ID, para que o usuário precise digitar seu próprio nome de arquivo ao salvar como caixa de diálogo a cada vez. Existe alguma maneira de definir um nome de arquivo padrão no código acima?

Você precisa definir o Content-Dispositioncabeçalho no HttpResponseMessage:

HttpResponseMessage response = new HttpResponseMessage();
response.StatusCode = HttpStatusCode.OK;
response.Content = new StreamContent(result);
response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
{
    FileName = "foo.txt"
};

EDIT: Como mencionado em um comentário, minha resposta não conta para caracteres que precisam ser escapados como a ;. Você deve usar a resposta aceita por Darin, se o nome do arquivo puder conter um ponto-e-vírgula.

Adicione um Response.AddHeader para definir o nome do arquivo

Response.AddHeader("Content-Disposition", "attachment; filename=*FILE_NAME*");

Apenas mude FILE_NAME para o nome do arquivo.

Se você deseja garantir que o nome do arquivo seja codificado corretamente, mas também evite o WebApi HttpResponseMessage, use o seguinte:

Response.AddHeader("Content-Disposition", new System.Net.Mime.ContentDisposition("attachment") { FileName = "foo.txt" }.ToString());

Você pode usar ContentDisposition ou ContentDispositionHeaderValue. Chamar o ToString em uma instância de qualquer um deles fará a codificação dos nomes dos arquivos para você.

Eu acho que isso pode ser útil para você.

Response.AddHeader("Content-Disposition", "attachment; filename=" + fileName)

Você precisa adicionar o cabeçalho de disposição do conteúdo à resposta:

 response.StatusCode = HttpStatusCode.OK;
 response.Content = new StreamContent(result);
 response.AppendHeader("content-disposition", "attachment; filename=" + fileName);
 return response;

Se você estiver usando o ASP.NET Core MVC, as respostas acima são ligeiramente alteradas ...

No meu método de ação (que retorna async Task<JsonResult>), adiciono a linha (em qualquer lugar antes da declaração de retorno):

Response.Headers.Add("Content-Disposition", $"attachment; filename={myFileName}");

Isso deve fazer:

Response.AddHeader("Content-Disposition", "attachment;filename="+ YourFilename)

Nota: A última linha é obrigatória.

Se não especificarmos Access-Control-Expose-Headers , não obteremos o nome do arquivo na interface do usuário.

FileInfo file = new FileInfo(FILEPATH);

HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
{
    FileName = file.Name
};
response.Content.Headers.Add("Access-Control-Expose-Headers", "Content-Disposition");

Considerando as respostas anteriores, é necessário ter cuidado com os caracteres globalizados.

Suponha que o nome do arquivo seja: " Esdrújula prenda ñame - güena.jpg "

Resultado bruto para o download: "Esdrújula prenda Amém - gena.jpg" [Feio]

Resultado HtmlEncode para download: "Esdr" - jula prenda & _241; ame - g & _252; ena.jpg "[Feio]

Resultado do UrlEncode para fazer o download: " Esdrújula + prenda + nome + - + güena.jpg " [OK]

Em seguida, você quase sempre precisa usar o UrlEncode sobre o nome do arquivo . Além disso, se você definir o cabeçalho de disposição do conteúdo como sequência direta, precisará garantir aspas entre aspas para evitar problemas de compatibilidade do navegador.

Response.AddHeader("Content-Disposition", $"attachment; filename=\"{HttpUtility.UrlEncode(YourFilename)}\"");

ou com auxílio de classe:

var cd = new ContentDisposition("attachment") { FileName = HttpUtility.UrlEncode(resultFileName) };
Response.AddHeader("Content-Disposition", cd.ToString());

O System.Net.Mime. A classe ContentDisposition cuida de aspas.