带有 id 的 ASP.NET WebAPI 2 版本控制 POST

Question

我正在尝试在现有的生产性 WebAPI 2 应用程序中实现“Microsoft.AspNet.WebApi.Versioning”nuget，以支持新设计的“v2”控制器。

到目前为止，大多数控制器都可以正常工作，但现在我遇到了一些 POST 控制器的问题。

示例代码：

using Microsoft.Web.Http;
using System.Web.Http;

namespace ApplicationApi.Controllers
{
    [ApiVersion("1.0")]
    [Route("api/version")]
    public class VersionController : ApiController
    {
        //Works
        [HttpGet]
        public IHttpActionResult Get()
        {
            return Ok(true);
        }

        //Throws  HTTP 405 - The requested resource with API version '1.0' does not support HTTP method 'POST'.
        [HttpPost]
        public IHttpActionResult Post(int id, [FromBody]dynamic value)
        {
            return Ok(true);
        }

        //Works
        [HttpPost]
        public IHttpActionResult Post([FromBody]dynamic value)
        {
            return Ok(true);
        }
    }
}

所有没有附加 {id} 的 POST 方法都有效。但是由于我们有大量的旧客户端很长一段时间，我必须保持旧版本正常运行，并且在旧控制器中删除 {id} 不是一个选项。在新的控制器中，不需要 {id}。

WebAPI 配置

var constraintResolver = new DefaultInlineConstraintResolver()
{
    ConstraintMap =
    {
        ["apiVersion"] = typeof( ApiVersionRouteConstraint )
    }
};
config.MapHttpAttributeRoutes(constraintResolver);

config.AddApiVersioning(options =>
{
    options.AssumeDefaultVersionWhenUnspecified = true;
});

config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

知道我做错了什么或如何解决这个问题吗？

Answer 1

问题与版本无关。

带有id 参数的方法不起作用的原因是您有冲突路由：

[Route("api/version")]

和

config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

对于名为Version 且具有Route("api/version") 属性的控制器，您只能拥有属性路由，或 常规路由（MVC / WebAPI 路由），但不能同时拥有。

在您的情况下，属性路由会覆盖 MVC，因此 api/version/{id} 不再存在。但是api/version?id 仍然有效，因为它是通过属性路由寻址的。

要解决该问题，您可以将控制器上的属性路由更改为 RoutePrefix 而不是 Route，并在必要时在每个操作上使用带有相对路径的 Route。 p>

必要表示您有常规路由无法解决的路由。

[ApiVersion("1.0")]
[RoutePrefix("api/version")]
public class VersionController : ApiController
{
    [HttpPost]
    public IHttpActionResult Post([FromBody] dynamic value)
    {
        return Ok();
    }

    [HttpPost]
    public IHttpActionResult Post(int id, [FromBody] dynamic value)
    {
        return Ok(1);
    }
}

Answer 2

试试

[ApiVersion("1.0")]
public class VersionController : ApiController
{
    //Works
    [HttpGet]
    [Route("api/version")]
    public IHttpActionResult Get()
    {
        return Ok(true);
    }

    //Throws  HTTP 405 - The requested resource with API version '1.0' does not support HTTP method 'POST'.
    [HttpPost]
    [Route("api/version/{id}")]
    public IHttpActionResult Post([FromUri]int id, [FromBody]dynamic value)
    {
        return Ok(true);
    }

    //Works
    [HttpPost]
    [Route("api/version")]
    public IHttpActionResult Post([FromBody]dynamic value)
    {
        return Ok(true);
    }
}

或

[ApiVersion("1.0")]
[RoutePrefix("api/version/")]
public class VersionController : ApiController
{
    //Works
    [HttpGet]
    public IHttpActionResult Get()
    {
        return Ok(true);
    }

    //Throws  HTTP 405 - The requested resource with API version '1.0' does not support HTTP method 'POST'.
    [HttpPost]
    [Route("{id}")]
    public IHttpActionResult Post([FromUri]int id, [FromBody]dynamic value)
    {
        return Ok(true);
    }

    //Works
    [HttpPost]
    public IHttpActionResult Post([FromBody]dynamic value)
    {
        return Ok(true);
    }
}

Answer 3

问题是你有 2 个 post 方法，而 api 不知道如何识别/生成资源名称。

您需要做的是添加重复方法名称的自定义资源名称。

因此，如果我们以您的示例为例，您可以将资源添加到引发异常的那个并保留另一个，或者给它们两个唯一的资源名称。

例如[HttpPost("id")]。

为了确认这一点，我用你的代码做了一个测试项目，为此我使用了 swagger，但它失败了。现在，当我将id 添加到这样的帖子方法之一时：

[HttpPost("id")]
public IActionResult Post(int id, [FromBody]dynamic value)
{
    return Ok(true);
}

[HttpPost]
public IActionResult Post([FromBody]dynamic value)
{
    return Ok(true);
}

然后它与以下输出一起工作：

主要答案的补充 在您的代码中，您允许通过在方法中添加 int id 来获取参数

 Post(int id, [FromBody]dynamic value)

如果您真的不想使用参数，那么您可以传递您自定义的对象类并执行类似的操作，而无需对其进行测试：

 Post([FromBody]MyCustomObjectClass data)

还有你MyCustomerObjectClass:

class MyCustomObjectClass {
    public int? Id { get; set; }
    public dynamic Value { get; set; }
}

你不需要2个post方法，你可以只有一个，ID可以是可选的。

只是为了不让你感到困惑。我在帖子中使用了[HttpPost("id")] 之类的 id 作为名称约定，这与您的方法 Id 参数无关，这是我的错。 id 在这种情况下只是资源的名称，它对操作没有影响。所以你可以把它叫做任何符合你逻辑的名字[HttpPost("post1")]和[HttpPost("post2")]。

最后一个建议，使用动态进行测试并在短时间内启动 api 很好，但我总是使用静态类型的对象。

我强烈建议您查看this。