WebApiCompatShim - 如何使用 MVC 6 配置 REST api

Question

我正在查看 this link，其中展示了如何从 Web API 2 迁移到 MVC 6。

我正在尝试在我的控制器中使用 HttpRequestMessage 绑定的 Action 方法。这适用于 Web Api 2.

 [Route("", Name = "AddTaskRoute")]        
 [HttpPost]        
 public Task    AddTask(HttpRequestMessage requestMessage, [FromBody]NewTask newTask)
 {            
      var task = _addTaskMaintenanceProcessor.AddTask(newTask); 
      return task;         
 }

并且 requestMessage 包含有关 Http 请求的详细信息，例如 headers、动词等

我正在尝试使用 MVC 6 获得相同的结果，但 requestMessage 似乎绑定不正确，它显示了详细信息，例如当操作实际上是 POST 时方法是 GET。我相信我没有按照文章的建议配置 WebApiCompatShim，所以绑定没有正确完成。但是我没有 "Microsoft.AspNet.Mvc.WebApiCompatShim": "6.0.0-rc1-final"

版本的扩展方法 services.AddWebApiConventions();

有人试过成功了吗？

PS：我的控制器中可用的 Request 属性似乎有关于 http 请求的详细信息，但我想要 HttpRequestMessage 实例。

Answer 1

在 MVC6 中，您应该可以使用 Request object 来获取 header 信息。

var contentTypeHeader = Request.Headers["Content-Type"];

他们确实删除了一些不错的方法，例如 Request.CreateResponse() 和 OK() 等。但是您可以使用一些替代方法。

我们将用来创建响应的所有这些 classes 都继承自 ObjectResult 基础 class。因此，您可以使用 ObjectResult 作为 Web api 方法的 return 类型。

HttpOKObjectResult

在 MVC6 中，您可以使用创建 HttpOKObjectResult class 的 object 并将其用作您的 return 值而不是 Request.CreateResponse()。这将为响应生成状态代码 200 OK。

Web API2 代码

public HttpResponseMessage Post([FromBody]string value)
{
    var item = new { Name= "test", id = 1 };
    return Request.CreateResponse(HttpStatusCode.OK,item);
}

MVC 6 代码

[HttpPost]
public ObjectResult Post([FromBody]string value)
{
    var item = new {Name= "test", id=1};
    return new HttpOkObjectResult(item);
}

或者直接使用OK()方法。

[HttpPost]
public ObjectResult Post([FromBody]string value)
{
    var item = new {Name= "test", id=1};
    return Ok(item);
}

CreatedAtRouteResult

您可以使用 CreatedAtRouteResult class 发送带有 201 Created 状态代码的响应，位置为 header.

MVC 6 代码

[HttpPost]
public ObjectResult Post([FromBody]string value)
{
    var item = new { Name= "test", id=250};
    return new CreatedAtRouteResult(new { id = 250}, item);
}

客户端将在响应中收到一个 location header，它将指向 api 路由，id 参数的值为 250。

HttpNotFoundObjectResult

您可以使用此 class 来 return 一个 404 Not found 响应。

Web API2 代码

public HttpResponseMessage Post([FromBody]string value)
{
    return Request.CreateResponse(HttpStatusCode.NotFound);   
}

MVC 6 代码

[HttpPost]
public ObjectResult Post([FromBody]string value)
{
    return new HttpNotFoundObjectResult("Some");
}

Answer 2

我发现要使用 Microsoft.AspNetCore.Mvc.WebApiCompatShim，它应该是 services.AddMvc().AddWebApiConventions() see this example instead of services.AddWebApiConventions() as shown in the docs。

我正在他们的文档中加入反馈项。

WebApiCompatShim - 如何使用 MVC 6 配置 REST api

WebApiCompatShim - how to configure for a REST api with MVC 6

migration

asp.net-core-mvc

asp.net-core

HttpOKObjectResult

CreatedAtRouteResult

HttpNotFoundObjectResult