WebAPI 2.0发布和删除路由

问题描述 投票:6回答:2

我在同一控制器上有两个动作,具有相同的路由,但有单独的HttpMethod要求(POSTDELETE)。

[AllowAnonymous]
public class TestController : ApiController
{
    [Route("~/api/test")]
    [HttpDelete]
    public IHttpActionResult Endpoint1()
    {
        return this.Ok("endpoint1");
    }

    [Route("~/api/test")]
    [HttpPost]
    public IHttpActionResult Endpoint2()
    {
        return this.Ok("endpoint2");
    }
}

这很好-从DELETE切换到POST时,两个端点都可以工作。

例如

DELETE /api/test = endpoint1
POST /api/test = endpoint2

如果我将动作分成单独的控制器,它将不再起作用:

[AllowAnonymous]
public class TestController : ApiController
{
    [Route("~/api/test")]
    [HttpDelete]
    public IHttpActionResult Endpoint1()
    {
        return this.Ok("endpoint1");
    }
}

[AllowAnonymous]
public class TestController2 : ApiController
{
    [Route("~/api/test")]
    [HttpPost]
    public IHttpActionResult Endpoint2()
    {
        return this.Ok("endpoint2");
    }
}

例如

DELETE /api/test = endpoint1
POST /api/test = { "Message": "The requested resource does not support http method 'POST'." }

这是应该从框架中获得的吗?

编辑:确切的WebAPI软件包版本为:5.2.3

c# asp.net-web-api asp.net-web-api-routing
2个回答
6
投票

发生了什么

Web API 2.0不允许路由在两个不同的控制器上匹配。这在MVC 6(Web API组合框架)中得以解决。

我该怎么办

首先像@woogy,然后您说,这不是很常见的模式,所以大多数用户不应该去这里(或在RTM上转至MVC 6)。

根本原因是路由实际匹配,定义为IActionHttpMethodProvider的动词不限制路由匹配,并且它在多个控制器上匹配,因此失败。

但是,您可以在路径上定义约束,并且副作用是获得了更简洁的API。

让我们开始吧

定义动词约束

这将限制路由以仅匹配预定义的动词,因此它将不匹配其他控制器。

public class VerbConstraint : IHttpRouteConstraint
{
    private HttpMethod _method;

    public VerbConstraint(HttpMethod method)
    {
        _method = method;
    }

    public bool Match(HttpRequestMessage request,
                      IHttpRoute route,
                      string parameterName,
                      IDictionary<string, object> values,
                      HttpRouteDirection routeDirection)
    {
        // Note - we only want to constraint on the outgoing path
        if (routeDirection == HttpRouteDirection.UriGeneration || 
            request.Method == _method)        
        {
            return true;
        }

        return false;
    }
}

为新属性定义抽象基类

public abstract class VerbRouteAttribute : RouteFactoryAttribute, IActionHttpMethodProvider
{
    private string _template;
    private HttpMethod _method;

    public VerbRouteAttribute(string template, string verb)
        : base(template)
    {
        _method = new HttpMethod(verb);
    }

    public Collection<HttpMethod> HttpMethods
    {
        get
        {
            var methods = new Collection<HttpMethod>();
            methods.Add(_method);

            return methods;
        }
    }

    public override IDictionary<string, object> Constraints
    {
        get
        {
            var constraints = new HttpRouteValueDictionary();
            constraints.Add("verb", new VerbConstraint(_method));
            return constraints;
        }
    }
}

该课程合并了三件事1.带有路由模板的路由属性2.将动词路由约束应用于路由3.指定操作方法选择器,以便系统的其余部分(如帮助页面)可以像[HttpPost] / [HttpDelete]

一样识别它

现在让我们定义实现

public class PostRouteAttribute : VerbRouteAttribute
{
    public PostRouteAttribute(string template) : base(template, "POST")
    {
    }
}

public class DeleteRouteAttribute : VerbRouteAttribute
{
    public DeleteRouteAttribute(string template) : base(template, "DELETE")
    {
    }
}

您所知道的这些都是微不足道的,只需在代码中更平滑地使用这些属性即可。

最后让我们应用新属性(并删除方法属性)

[AllowAnonymous]
public class TestController : ApiController
{
    [DeleteRoute("api/test")]
    public IHttpActionResult Endpoint1()
    {
        return this.Ok("endpoint1");
    }
}

[AllowAnonymous]
public class TestController2 : ApiController
{
    [PostRoute("api/test")]
    public IHttpActionResult Endpoint2()
    {
        return this.Ok("endpoint2");
    }
}

0
投票

[HttpDelete(“ DeleteEmployee / {id}”)]公共异步任务DeleteEmployee(Guid id)

© www.soinside.com 2019 - 2024. All rights reserved.