Web Api 2 API无法识别路由的多个属性(版本控制)

时间:2014-10-10 20:38:06

标签: c# asp.net asp.net-web-api versioning asp.net-web-api2

我正在尝试从Attribute Routing实现RoutingConstaints SampleVersionedRoute,但是当我在控制器上同时使用它们时,版本化属性不再有效。

我需要修改哪些属性才能让它与属性路由一起使用?

对于代码示例,下载示例项目(或者只查看上面链接中的几个文件),然后修改路由:

// When I use the RoutePrefix, VersionedRoute no longer works (Sending "Api-Version" through http header doesn't route correctly
// If I remove the RoutePrefix I can use VersionedRoute again
// What do I need to change in its code to be able to use both?

[VersionedRoute("api/Customers", 1)] // This route would be used as http://url/api/customers with a header of "api-version: 1"
[RoutePrefix("api/v1/Customers")] // This route would be used purely through url versioning of http://url/api/v1/Customers
public class CustomersV1Controller : ApiController {

    /* Other stuff removed */

    [VersionedRoute("api/Customer", 1)] // I'd rather not have to use this here at all and just use a single one on the class, but having both nor just one on either works right now.
    [Route("")]
    public IHttpActionResult Get()
    {
        return Json(_customers);
    }
}

VersionedRoute Code

VersionConstraint Code

编辑:如果您需要更多信息,甚至发布想法或事物,请告诉我们:)

Edit2:以下是我试图通过Troy Hunt的博客做的一个例子:http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html

Edit3:这是我想要编写的代码,因为它可以减少大量的开销和魔术字符串。

[VersionedRoute("api/Customers", 1)] // This route would be used as http://url/api/customers with a header of "api-version: 1"
[RoutePrefix("api/v1/Customers")] // This route would be used purely through url versioning of http://url/api/v1/Customers
public class CustomersV1Controller : ApiController {

    /* Other stuff removed */
    [Route("")]
    public IHttpActionResult Get()
    {
        // Removed
        return Ok(customers);
    }


    [Route("{id:int}")]
    public IHttpActionResult GetById(int id)
    {
        // Removed
        return Ok(customer);
    }
}

[VersionedRoute("api/Customers", 2)] // This route would be used as http://url/api/customers with a header of "api-version: 2"
[RoutePrefix("api/v2/Customers")] // This route would be used purely through url versioning of http://url/api/v2/Customers
public class CustomersV2Controller : ApiController {

    /* Other stuff removed */
    [Route("")]
    public IHttpActionResult Get()
    {
        // Removed
        return Ok(customersThatAreDifferentThanV1);
    }


    [Route("{id:int}")]
    public IHttpActionResult GetById(int id)
    {
        // Removed
        return Ok(customerThatIsDifferent);
    }
}

编辑:最后一次尝试,只需要在每个路径上编写一次路由版本信息,在控制器属性级别而不是每次操作。

1 个答案:

答案 0 :(得分:13)

RouteVersionedRoute属性可以正常运行,但您的RoutePrefix属性也适用于VersionedRoute(尝试访问/ api / v1 / Customers / api / Customer - 设置api-version标头时会收到响应)

以下代码会针对示例中返回正确答案的两个网址产生所需的行为,但显然这并不能解决您想要一个VersionedRoute和一个RoutePrefix的问题。最好的。为此需要另一种方法。但是,您可以为不同的api版本提供单独的控制器。

[RoutePrefix("api")]
public class CustomersV1Controller : ApiController
{
    /* Other stuff removed */

    [VersionedRoute("Customers", 1)]
    [Route("v1/Customers")]
    public IHttpActionResult Get()
    {
        return Json(_customers);
    }
}

改进是创建自己的属性而不是Route,因此您不需要每次都为版本添加前缀:

public class CustomVersionedRoute : Attribute, IHttpRouteInfoProvider
{
    private readonly string _template;

    public CustomVersionedRoute(string route, int version)
    {
        _template = string.Format("v{0}/{1}", version, route);
    }

    public string Name { get { return _template; } }
    public string Template { get { return _template ; } }
    public int Order { get; set; }
}

[RoutePrefix("api")]
public class CustomersV2Controller : ApiController
{
    /* Other stuff removed */

    [VersionedRoute("Customers", 2)]
    [CustomVersionedRoute("Customers", 2)]
    public IHttpActionResult Get()
    {
        return Json(_customers);
    }
}