一.返回类型

　　ASP.NET Core 提供以下 Web API Action方法返回类型选项，以及说明每种返回类型的最佳适用情况：

　　(1) 固定类型

　　(2) IActionResult

　　(3) ActionResult<T>

　　

　　1.1 固定类型

　　　　最简单的操作是返回基元或复杂数据类型（如 string 或自定义对象类型）。 请参考以下Action，该Action返回自定义 Product 对象的集合：

[HttpGet]
public IEnumerable<Product> Get()
{
    return _repository.GetProducts();
}

 　　　　适用场景：在执行Action期间，无需要根据条件判断返回不同类型，只返回固定类型即可满足要求。 上述操作不接受任何参数，因此不需要参数约束验证。

 

　　1.2  IActionResult类型

　　　　当Action方法中可能有多个 ActionResult 返回类型时，适合使用 IActionResult 返回类型。ActionResult 类型可以表示多种 HTTP 状态代码。 属于此类别的一些常见返回类型包括：BadRequestResult (400)、NotFoundResult (404) 和 OkObjectResult (200)。

　　　　由于Action方法中有多个返回类型和路径，因此必须使用 [ProducesResponseType] 特性。 此特性可针对 Swagger 等工具生成的 API 帮助页生成更多描述性响应详细信息(上篇有介绍)。 [ProducesResponseType] 指示Action将返回的已知类型和 HTTP 状态代码。

　　　　下面是一个同步Action，该Action方法中可能有两种返回类型：

[HttpGet("{id}")]
[ProducesResponseType(typeof(Product), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public IActionResult GetById(int id)
{
    if (!_repository.TryGetProduct(id, out var product))
    {
        return NotFound();
    }

    return Ok(product);
}

 　　　　下面是一个异步Action，该Action方法中可能有两种返回类型：

[HttpPost]
[ProducesResponseType(typeof(Product), StatusCodes.Status201Created)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<IActionResult> CreateAsync([FromBody] Product product)
{
    if (product.Description.Contains("XYZ Widget"))
    {
        return BadRequest();
    }

    await _repository.AddProductAsync(product);

    return CreatedAtAction(nameof(GetById), new { id = product.Id }, product);
}

 　　　　适用场景：当Action方法中可能有多个 ActionResult 返回类型时，适合使用 IActionResult 返回类型。

 

　　1.3 ActionResult<T>

 　　　　ASP.NET Core 2.1 引入了 ActionResult<T> 返回类型。 它支持返回从 ActionResult 派生的类型或返回固定类型。ActionResult<T> 提供以下优势：

 　　　　(1) 简化ProducesResponseType  例如：[ProducesResponseType(200, Type = typeof(Product))] 可简化为 [ProducesResponseType(200)]

　　　　 (2) 隐式强制转换运算符，将 T 转换为 ObjectResult，也就是将 return new ObjectResult(T); 简化为 return T;

　　　　下面是同步示例，(1)简化ProducesResponseType，(2)返回隐式转换。

[HttpGet("{id}")]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public ActionResult<Product> GetById(int id)
{
    if (!_repository.TryGetProduct(id, out var product))
    {
        return NotFound();
    }
   // return new ObjectResult(product);
    return product;
}

 　　　　下面是异步示例：

[HttpPost]
[ProducesResponseType(StatusCodes.Status201Created)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult<Product>> CreateAsync(Product product)
{
    if (product.Description.Contains("XYZ Widget"))
    {
        return BadRequest();
    }

    await _repository.AddProductAsync(product);

    return CreatedAtAction(nameof(GetById), new { id = product.Id }, product);
}

 　　　　适用场景：对比IActionResult类型适用场景，它提供了二种优势。

　　　　最后建议：不要用特定类型返回。 对于有返回类型的使用ActionResult<T>,相反对于没有返回类型的使用IActionResult。 二者使用在“ asp.net core系列 36 WebAPI 搭建详细示例”中有介绍。

 

二.响应数据的格式化

　　响应数据是：response返回到客户端的数据。在ASP.NET Core MVC 中，包含对固定格式(json,xml,string..)或根据客户端规范(Accept)来设置响应数据格式的内置支持。默认返回json数据格式。