如何让我的API操作接受null复杂类型?

时间:2014-04-29 15:52:34

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

所以这很完美

//localhost:1234/api/task/getData?id=1&name=test&phone=123456

public object GetData(long id, [FromUri] User complexType)
{
    //complexType is binding correctly
    return runSomeCode(id, complexType ?? User.Current);
}

但事实并非如此。不确定如何指定空复杂类型。

//localhost:1234/api/task/getData?id=1

public object GetData(long id, [FromUri] User complexType)
{
    //complexType is not null, but all class properties are
    return runSomeCode(id, complexType ?? User.Current);
}

我甚至试过了这个,但遇到了“找到符合请求的多个动作”的新问题

//localhost:1234/api/task/getData?id=1

public object GetData(long id)
{
    return runSomeCode(id, User.Current);
}

public object GetData(long id, [FromUri] User complexType)
{
    return runSomeCode(id, complexType);
}

这是我的复杂类看起来像

public class User
{
    public string Name {get;set;}
    public string Phone {get;set;}

    public static User Current
    {
        get
        {
            //code to get the current user
        }
    }
}

更新 我知道将我的方法更改为POST并使用正文内容有效,但是我可以说我很顽固并且希望使用GET完成此操作。

如何在web api GET请求中使复杂参数为空?排除它不像在POST请求中那样工作。

1 个答案:

答案 0 :(得分:1)

我认为您正在寻找的是如何定义"路由规则"

WebApi 2.0 让我们使用名为Route的属性来定义不同的资源网址"使用一些规则(约束),如长度,格式和默认值

例如:

public class SomeController : ApiController{
     //where author is a letter(a-Z) with a minimum of 5 character and 10 max.      
    [Route("html/{id}/{newAuthor:alpha:length(5,10)}/age:int?")]
    public Book Get(int id, string newAuthor , int age){
        return new Book() { Title = "SQL Server 2012 id= " + id, Author = "Adrian & " + newAuthor };
    }

参数年龄的类型为integer 可选

或者像这样使用默认值:

[Route("html/{id}/{newAuthor:alpha:length(5,10)}/age:int=33")]
public Book Get(int id, string newAuthor , int age){
  return new Book() { Title = "SQL Server 2012 id= " + id, Author = "Adrian & " + newAuthor };
}
    ...

或者能够根据您的需求定制您的路线,例如:

[Route("url1/{id}")]
public Book Get(int id){
   return new Book() { Title = "SQL Server 2012 id= " + id, Author = "Adrian " };
}

[Route("url1/{id}/{author}")]
public Book Get(int id, string author){
   return new Book() { Title = "SQL Server 2012 id= " + id, Author = "Adrian & " + author };
}
...

在WebApi的第一个版本中,这必须在WebApiConfig类中完成,但选项不一样,我认为该版本唯一真正的选项是使用正则表达式。

回到Web.Api 20,您还可以通过继承IHttpRouteConstraint

来定义自己的约束来处理自己的复杂类型

有关您在WEB.Api文档网站上描述的方案的其他信息,您可能需要实施TypeConverter

http://www.asp.net/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api