ASP.NET Core 中的响应类型

Question

我刚刚将我的项目从 ASP.Net 4.5 移至 ASP.Net Core。 我有一个用于返回 blob 但现在返回 JSON 的 REST API。

这是旧代码：

[HttpGet]
[ResponseType(typeof(HttpResponseMessage))]
[Route("Download/{documentId}")]
public async Task<HttpResponseMessage> DownloadDocument(string documentId)
{
    try
    {
        var result = await TheDocumentService.DownloadDocument(documentId);

        return result;
    }
    catch (Exception ex)
    {
        return new HttpResponseMessage
        {
            StatusCode = HttpStatusCode.InternalServerError,
            Content = new StringContent(ex.Message)
        };
    }
}

除了[ResponseType(typeof(HttpResponseMessage))] 在 ASP.Net Core 中不起作用之外，ASP.net Core 中的代码相同，两种解决方案的返回结果也相同。

但是当在客户端查看来自服务器的响应时，它们会有所不同。

所以它们之间唯一不同的是[ResponseType(typeof(HttpResponseMessage))]。 asp.net core 中有没有等价的东西？

Answer 1

How to to return an image with Web API Get method

我通过改变我的回报来解决它：

[HttpGet]
[Route("Download/{documentId}")]
public async Task<IActionResult> DownloadDocument(string documentId)
{
    try
    {
        var result = await TheDocumentService.DownloadDocument(documentId);
        var content = await result.Content.ReadAsByteArrayAsync();
        return File(content, result.Content.Headers.ContentType.ToString());
    }
    catch (Exception ex)
    {
        return StatusCode(500, ex);
    }
}

Answer 2

编辑：@President Camacho 说 [ResponseType...] 在 .net 核心中不起作用。它已被 [ProducesResponseType] 取代：

[HttpGet]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<int>))]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult<IEnumerable<User>>> Get...()

微软的解释很好：https://docs.microsoft.com/en-us/aspnet/core/web-api/action-return-types?view=aspnetcore-6.0#iactionresult-type 该网站的一句话总结道：“该属性为 Swagger 等工具生成的 Web API 帮助页面生成更多描述性响应详细信息。”

对于其他不想看源代码来开发 UI 的团队成员也有好处。

Answer 3

Dot Net Core 相当于[ResponseType(typeof(HttpResponseMessage))] 是[Produces(typeof(HttpResponseMessage))]