ASP.NET WebAPIでファイル（FileContentResult）を返す方法

通常のMVCコントローラーでは、pdfをで出力できますFileContentResult。

public FileContentResult Test(TestViewModel vm)
{
    var stream = new MemoryStream();
    //... add content to the stream.

    return File(stream.GetBuffer(), "application/pdf", "test.pdf");
}

しかし、どうすればそれをに変更できApiControllerますか？

[HttpPost]
public IHttpActionResult Test(TestViewModel vm)
{
     //...
     return Ok(pdfOutput);
}

これが私が試したものですが、うまくいかないようです。

[HttpGet]
public IHttpActionResult Test()
{
    var stream = new MemoryStream();
    //...
    var content = new StreamContent(stream);
    content.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");
    content.Headers.ContentLength = stream.GetBuffer().Length;
    return Ok(content);            
}

ブラウザに表示される返される結果は次のとおりです。

{"Headers":[{"Key":"Content-Type","Value":["application/pdf"]},{"Key":"Content-Length","Value":["152844"]}]}

また、SO：ASP.NET Web APIのコントローラーからバイナリファイルを返すという同様の投稿があります 。既存のファイルの出力について話します。しかし、ストリームで動作させることはできませんでした。

助言がありますか？

代わりに返すStreamContentようContentに、私はそれをして動作させることができますByteArrayContent。

[HttpGet]
public HttpResponseMessage Generate()
{
    var stream = new MemoryStream();
    // processing the stream.

    var result = new HttpResponseMessage(HttpStatusCode.OK)
    {
        Content = new ByteArrayContent(stream.ToArray())
    };
    result.Content.Headers.ContentDisposition =
        new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
    {
        FileName = "CertificationCard.pdf"
    };
    result.Content.Headers.ContentType =
        new MediaTypeHeaderValue("application/octet-stream");

    return result;
}

返品したい場合IHttpActionResultは、次のようにしてください。

[HttpGet]
public IHttpActionResult Test()
{
    var stream = new MemoryStream();

    var result = new HttpResponseMessage(HttpStatusCode.OK)
    {
        Content = new ByteArrayContent(stream.GetBuffer())
    };
    result.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
    {
        FileName = "test.pdf"
    };
    result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");

    var response = ResponseMessage(result);

    return response;
}

この質問は私を助けました。

だから、これを試してください：

コントローラーコード：

[HttpGet]
public HttpResponseMessage Test()
{
    var path = System.Web.HttpContext.Current.Server.MapPath("~/Content/test.docx");;
    HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK);
    var stream = new FileStream(path, FileMode.Open);
    result.Content = new StreamContent(stream);
    result.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment");
    result.Content.Headers.ContentDisposition.FileName = Path.GetFileName(path);
    result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
    result.Content.Headers.ContentLength = stream.Length;
    return result;          
}

HTMLマークアップの表示（クリックイベントと単純なURLを使用）：

<script type="text/javascript">
    $(document).ready(function () {
        $("#btn").click(function () {
            // httproute = "" - using this to construct proper web api links.
            window.location.href = "@Url.Action("GetFile", "Data", new { httproute = "" })";
        });
    });
</script>


<button id="btn">
    Button text
</button>

<a href=" @Url.Action("GetFile", "Data", new { httproute = "" }) ">Data</a>

以下は、バッファリングせずにファイルのコンテンツをストリーミングする実装です（byte [] / MemoryStreamなどでのバッファリングは、大きなファイルの場合、サーバーの問題になる可能性があります）。

public class FileResult : IHttpActionResult
{
    public FileResult(string filePath)
    {
        if (filePath == null)
            throw new ArgumentNullException(nameof(filePath));

        FilePath = filePath;
    }

    public string FilePath { get; }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        var response = new HttpResponseMessage(HttpStatusCode.OK);
        response.Content = new StreamContent(File.OpenRead(FilePath));
        var contentType = MimeMapping.GetMimeMapping(Path.GetExtension(FilePath));
        response.Content.Headers.ContentType = new MediaTypeHeaderValue(contentType);
        return Task.FromResult(response);
    }
}

次のように簡単に使用できます。

public class MyController : ApiController
{
    public IHttpActionResult Get()
    {
        string filePath = GetSomeValidFilePath();
        return new FileResult(filePath);
    }
}

どの部分を非難するかは正確にはわかりMemoryStreamませんが、次の理由で動作しません。

に書き込むとMemoryStream、そのPositionプロパティがインクリメントされます。のコンストラクタはStreamContent、ストリームの現在のPosition。したがって、ストリームに書き込み、それをに渡すとStreamContent、ストリームの最後の何もないところから応答が開始されます。

これを適切に修正するには2つの方法があります。

1）コンテンツを作成し、ストリームに書き込みます

[HttpGet]
public HttpResponseMessage Test()
{
    var stream = new MemoryStream();
    var response = Request.CreateResponse(HttpStatusCode.OK);
    response.Content = new StreamContent(stream);
    // ...
    // stream.Write(...);
    // ...
    return response;
}

2）ストリームへの書き込み、位置のリセット、コンテンツの構築

[HttpGet]
public HttpResponseMessage Test()
{
    var stream = new MemoryStream();
    // ...
    // stream.Write(...);
    // ...
    stream.Position = 0;

    var response = Request.CreateResponse(HttpStatusCode.OK);
    response.Content = new StreamContent(stream);
    return response;
}

2）ストリームが新しい場合は少し良く見える、1）ストリームが0で始まらない場合はよりシンプル

私にとってそれは違いでした

var response = Request.CreateResponse(HttpStatusCode.OK, new StringContent(log, System.Text.Encoding.UTF8, "application/octet-stream");

そして

var response = Request.CreateResponse(HttpStatusCode.OK);
response.Content = new StringContent(log, System.Text.Encoding.UTF8, "application/octet-stream");

最初のものは、StringContentのJSON表現を返していました：{"Headers"：[{"Key"： "Content-Type"、 "Value"：["application / octet-stream; charset = utf-8"]}]}

2つ目は適切なファイルを返していました。

Request.CreateResponseには、2番目のパラメーターとして文字列を受け取るオーバーロードがあり、これが実際のコンテンツではなく、StringContentオブジェクト自体を文字列としてレンダリングする原因となったようです。