Comment faire pour retourner un fichier à l'aide de l'API Web?

Je suis en utilisant ASP.NET l'API Web.
Je veux télécharger un fichier PDF avec C# à partir de l'API (que l'API génère).

Puis-je avoir l'API de revenir un byte[]? et pour l'application en C# peut je viens de faire:

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

et 

File.WriteAllBytes()?
InformationsquelleAutor Kyle | 2012-06-20
  1. 153

    Mieux retourner HttpResponseMessage avec StreamContent à l'intérieur d'elle.

    Ici est un exemple:

    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 de commentaire par patridge:
    Quelqu'un d'autre devrait obtenir ici à la recherche d'envoyer une réponse à partir d'un tableau d'octets au lieu d'un fichier, vous allez avoir à utiliser de nouvelles ByteArrayContent(someData) au lieu de StreamContent (voir ici).

    • Première chose - ce code provoque une exception puisque vous êtes newing deux FileStream les objets pointés dans le même fichier. Deuxième chose, c'est que vous ne souhaitez pas utiliser de "l'Aide", parce que dès que la variable est hors de portée, .NET va disposer et vous obtiendrez des messages d'erreur sur la connexion sous-jacente étant fermé.
    • Quelqu'un d'autre devrait obtenir ici à la recherche d'envoyer une réponse à partir d'un tableau d'octets au lieu d'un fichier, vous allez avoir à utiliser new ByteArrayContent(someData) au lieu de StreamContent (voir ici).
    • Vous pouvez également remplacer la base dispose() de sorte que vous pouvez gérer vos ressources correctement lorsque le cadre de l'appel.
    • Est ByteArrayContent mieux que response.BinaryWrite?
    • Je ne suis pas sûr. Je n'ai pas utilisé Response.BinaryWrite. Je devine que ce serait jeter octets dans le flux directement plutôt que de la gestion de contenu à l'aide de l'API Web de pipeline en place. Si vous avez d'autres étapes de traitement dans l'API pipeline qui doivent s'exécuter sur le contenu avant qu'il descend le fil, vous pouvez coller avec ByteArrayContent. Du mieux que je peux donner est de vous suggérer de voir ce qui fonctionne le mieux pour votre situation.
    • Qu'est-ce que le fileSize variable utilisée dans le code ci-dessus? Devrait/pourrait-il être envoyé dans les en-têtes de réponse?
    • C'était une réponse utile, mais un utilisateur a signalé ne pas être en mesure d'ouvrir des fichiers pdf retourné au client de cette manière à l'aide de Firefox. Les fichiers ouverts dans Firefox "filename.pdf.htm", qui serait la cause de la file de ne pas s'ouvrir correctement. Chrome, IE, Bord tout a bien fonctionné. J'ai trouvé la solution, vous devez également définir le ContentType comme ceci: la réponse.Contenu.Les en-têtes.ContentType = new MediaTypeHeaderValue("application/pdf");
    • Code mis à jour en conséquence pour votre commentaire
    • Je tiens à souligner que la bonne MediaTypeHeaderValue est crucial et pour l'obtenir dynamique si vous avez différents types de fichiers que vous pouvez faire comme ceci. (d'où le nom de fichier est une chaîne et a un type de fichier se terminant le souhaitez .jpg, .pdf, docx, etc..) var contentType = MimeMapping.GetMimeMapping(fileName); réponse.Contenu.Les en-têtes.ContentType = new MediaTypeHeaderValue(contentType);
    • Le FileStream obtenir éliminés automatiquement?

    InformationsquelleAutor Regfor
  2. 33

    J'ai fait le suivi de l'action:

    [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);
    }
}
    • Cela répond à la question
    • Ce ne serait pas une bonne idée avec de gros fichiers depuis qu'il charge la totalité de l'image dans la mémoire. Le flux est la meilleure option.
    • Parfait... mais dans beaucoup de cas, vous n'avez pas besoin de traiter de gros fichiers. Mais je suis totalement d'accord avec votre point de vue!
    InformationsquelleAutor André de Mattos Ferraz
  3. 8

    Exemple avec IHttpActionResult dans ApiController.

    [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;
}

    Si vous ne voulez pas télécharger le PDF et utiliser un des navigateurs construit visionneuse de documents PDF au lieu de supprimer les deux lignes suivantes:

    responseMsg.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");
responseMsg.Content.Headers.ContentDisposition.FileName = file.FileName;
    • Oui, vous obtenez le fichier avec var file = GetFile(id);. file.SomeData est un Tableau d'Octets (byte[]) et file.FileNameest string.
    • Merci pour votre post. 'HttpResponseMessage' ne fonctionne pas pour moi à l'intérieur d'un ApiController, donc vous m'avez sauvé.
    InformationsquelleAutor Ogglas
  4. 5

    Juste une note pour .Net Core: Nous pouvons utiliser la FileContentResult et définir le contentType à application/octet-stream si nous voulons envoyer les octets brutes. Exemple:

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