如何在Web API中支持空RouteAttribute?

时间:2015-07-27 18:56:16

标签: c# asp.net asp.net-mvc-4 asp.net-web-api asp.net-web-api-routing

我有这堂课:

[RoutePrefix("api/v2/Foo")]
public class SomeController : BaseController
{
    [Route("")]
    [HttpGet]
    public async Task<HttpResponseMessage> Get(SomeEnum? param)
    {
        //...
    }
}

我想通过以下方式致电: api/v2/Foo?param=Bar 但它没有用。

如果我因此更改路由属性以在RouteAttribute中包含某些内容:

    [Route("SomeRoute")]
    [HttpGet]
    public async Task<HttpResponseMessage> Get(SomeEnum? param)
    {
        //...
    }

...然后我可以打电话 api/v2/Foo/SomeRoute?param=Bar ,但这不是我想要的。

如何让第一个环境工作?

编辑: Domas Masiulis引导我走向答案:上面的场景是有效的,只是默认的全局布线搞砸了。我通过添加符合我们惯例的单独默认路由来解决问题...

    public static void RegisterRoutes(RouteCollection routes)
    {
        //ADDING THIS FIXED MY ISSUE
        routes.MapHttpRoute(
            name: "API Default",
            routeTemplate: "api/v2/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        //SOURCE OF THE ORIGINAL PROBLEM
        routes.MapRoute(
           "Default", // Route name
           "{controller}/{action}/{id}", // URL with parameters
           new { controller = "Administration", action = "Index", id = UrlParameter.Optional } // Parameter defaults
       );
    }

2 个答案:

答案 0 :(得分:8)

有什么特殊条件吗?也许隐藏在BaseController中的东西? RouteConfig中的任何自定义配置?

你给出的例子对我有用,做了一个快速测试:

使用过的代码:

[RoutePrefix("api/v2/Foo")]
public class SomeController : ApiController
{
    [Route("")]
    [HttpGet]
    public Task<int> Get(int param)
    {
        return Task.FromResult(2);
    }
}

呼叫 http://localhost:1910/api/v2/Foo?param=1按预期工作 - 返回2.

答案 1 :(得分:0)

1)您必须为查询参数

指定[FromUri]属性

2)如果使用像SomeEnum这样的可空参数?为它设置默认值

[Route("")]
[HttpGet]
public async Task<HttpResponseMessage> Get([FromUri] SomeEnum? param = null)
{
    //...
}