从同一个控制器路由多个GET方法 - Web Api

时间:2013-10-16 15:54:54

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

我目前正在处理Web Api的问题。

我有一个带两个Get方法的控制器。一个返回对象列表的。另一个返回同一个对象的列表,但是根据传入的一些参数进行过滤。如下所示:

public IList<MyObject> Get(int id)
{
  //Code here looks up data, for that Id
}

public IList<MyObject> Get(int id, string filterData1, string filterData2)
{
  //code here looks up the same data, but filters it based on 'filterData1' and 'filterData2'
}

我不能让路线为此工作。特别是因为Api帮助页面似乎多次显示相同的URL。

我的路线看起来像:

            config.Routes.MapHttpRoute(
            name: "FilterRoute",
            routeTemplate:  "api/Mycontroller/{Id}/{filterData1}/{filterData2}",
            defaults: new { controller = "Mycontroller" }
        );

        config.Routes.MapHttpRoute(
            name: "normalRoute",
            routeTemplate: "api/Mycontroller/{Id}",
            defaults: new { controller = "Mycontroller" }
        );

有人知道吗?

此外,是否可以将我的过滤方法更改为

public IList<MyObject> Get(int Id, FilterDataObject filterData)
{
   //code here
}

或者你不能在Get?

上传递复杂的对象

2 个答案:

答案 0 :(得分:1)

尝试查看attribute routing nuget包。这允许您为控制器中的每个方法定义自定义URL。

关于你的第二个问题,你不能通过get请求发送复杂的对象,因为没有请求体来保存值,你需要使用POST方法来执行此操作。

答案 1 :(得分:1)

假设您有以下路线:

routes.MapHttpRoute(
    name: "Default", 
    routeTemplate: "api/{controller}/{id}/{p1}/{p2}",
    defaults: new { id = RouteParameter.Optional, p1 = RouteParameter.Optional, p2 = RouteParameter.Optional });

GET api/controller?p1=100映射到public HttpResponseMessage Get(int p1) {}

GET api/controller/1?p1=100映射到public HttpResponseMessage Get(int id, int p1) {}

GET api/controller/1映射到public HttpResponseMessage Get(int id) {}

依旧......

GET和复杂模型绑定:根据定义,复杂模型应该在请求体中(动词无关)(url包含可以破坏复杂模型的长度限制)。您可以通过执行以下操作强制WebApi在URL中查找复杂模型:

routes.MapHttpRoute(
    name: "Default", 
    routeTemplate: "api/{controller}/{customer}");

public class Customer
{
    public int Id { get; set; }
    public string Name { get; set; }
}

public HttpResponseMessage Get([FromUri] Customer customer) {};

GET api/customers?id=1&name=Some+name

只需注意:GET具有复杂类型,大部分时间(如我的示例)都没有意义。为什么要通过ID和名称获得客户?根据定义,复杂类型需要POST(CREATE)或PUT(UPDATE)。

要使用子文件夹结构调用,请尝试:

routes.MapHttpRoute(
    "MyRoute",
    "api/{controller}/{id}/{p1}/{p2}",
    new { id = UrlParameter.Optional, p1 = UrlParameter.Optional, p2 = UrlParameter.Optional, Action = "Get"});

GET /api/controller/2134324/123213/31232312

public HttpResponseMessage Get(int id, int p1, int p2) {};