Wie kann ich eine Datei mit der Web-API zurückgeben?

Ich verwende die ASP.NET-Web-API .
Ich möchte ein PDF mit C # von der API herunterladen (die die API generiert).

Kann ich die API einfach a zurückgeben lassen byte[]? und für die C # -Anwendung kann ich einfach tun:

byte[] pdf = client.DownloadData("urlToAPI");? 

und

File.WriteAllBytes()?

Es ist besser, HttpResponseMessage mit StreamContent zurückzugeben.

Hier ist ein Beispiel:

public HttpResponseMessage GetFile(string id)
{
    if (String.IsNullOrEmpty(id))
        return Request.CreateResponse(HttpStatusCode.BadRequest);

    string fileName;
    string localFilePath;
    int fileSize;

    localFilePath = getFileFromID(id, out fileName, out fileSize);

    HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = new StreamContent(new FileStream(localFilePath, FileMode.Open, FileAccess.Read));
    response.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");
    response.Content.Headers.ContentDisposition.FileName = fileName;
    response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");

    return response;
}

UPD von Kommentar von patridge : Sollte jemand anderes hierher kommen, um eine Antwort von einem Byte-Array anstelle einer tatsächlichen Datei zu senden, sollten Sie anstelle von StreamContent einen neuen ByteArrayContent (someData) verwenden (siehe hier ).

Ich habe folgende Aktion ausgeführt:

[HttpGet]
[Route("api/DownloadPdfFile/{id}")]
public HttpResponseMessage DownloadPdfFile(long id)
{
    HttpResponseMessage result = null;
    try
    {
        SQL.File file = db.Files.Where(b => b.ID == id).SingleOrDefault();

        if (file == null)
        {
            result = Request.CreateResponse(HttpStatusCode.Gone);
        }
        else
        {
            // sendo file to client
            byte[] bytes = Convert.FromBase64String(file.pdfBase64);


            result = Request.CreateResponse(HttpStatusCode.OK);
            result.Content = new ByteArrayContent(bytes);
            result.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");
            result.Content.Headers.ContentDisposition.FileName = file.name + ".pdf";
        }

        return result;
    }
    catch (Exception ex)
    {
        return Request.CreateResponse(HttpStatusCode.Gone);
    }
}

Beispiel mit IHttpActionResultinApiController .

[HttpGet]
[Route("file/{id}/")]
public IHttpActionResult GetFileForCustomer(int id)
{
    if (id == 0)
      return BadRequest();

    var file = GetFile(id);

    IHttpActionResult response;
    HttpResponseMessage responseMsg = new HttpResponseMessage(HttpStatusCode.OK);
    responseMsg.Content = new ByteArrayContent(file.SomeData);
    responseMsg.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");
    responseMsg.Content.Headers.ContentDisposition.FileName = file.FileName;
    responseMsg.Content.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");
    response = ResponseMessage(responseMsg);
    return response;
}

Wenn Sie die PDF-Datei nicht herunterladen und einen im PDF-Viewer integrierten Browser verwenden möchten, entfernen Sie stattdessen die folgenden zwei Zeilen:

responseMsg.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");
responseMsg.Content.Headers.ContentDisposition.FileName = file.FileName;

Nur ein Hinweis für .Net Core: Wir können das verwenden FileContentResultund den contentType auf setzen, application/octet-streamwenn wir die Rohbytes senden möchten. Beispiel:

[HttpGet("{id}")]
public IActionResult GetDocumentBytes(int id)
{
    byte[] byteArray = GetDocumentByteArray(id);
    return new FileContentResult(byteArray, "application/octet-stream");
}

Ich habe mich gefragt, ob es eine einfache Möglichkeit gibt, eine Datei auf eine "allgemeinere" Weise herunterzuladen. Ich habe mir das ausgedacht.

Es ist eine einfache ActionResultMethode, mit der Sie eine Datei von einem Controller-Aufruf herunterladen können, der eine zurückgibt IHttpActionResult. Die Datei wird in der gespeichert byte[] Content. Sie können es bei Bedarf in einen Stream verwandeln.

Ich habe dies verwendet, um Dateien zurückzugeben, die in der varbinary-Spalte einer Datenbank gespeichert sind.

    public class FileHttpActionResult : IHttpActionResult
    {
        public HttpRequestMessage Request { get; set; }

        public string FileName { get; set; }
        public string MediaType { get; set; }
        public HttpStatusCode StatusCode { get; set; }

        public byte[] Content { get; set; }

        public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
        {
            HttpResponseMessage response = new HttpResponseMessage(StatusCode);

            response.StatusCode = StatusCode;
            response.Content = new StreamContent(new MemoryStream(Content));
            response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment");
            response.Content.Headers.ContentDisposition.FileName = FileName;
            response.Content.Headers.ContentType = new MediaTypeHeaderValue(MediaType);

            return Task.FromResult(response);
        }
    }