ASP.NET Web API中的可选查询字符串参数

我需要实现以下WebAPI方法：

/api/books?author=XXX&title=XXX&isbn=XXX&somethingelse=XXX&date=XXX

所有查询字符串参数都可以为null。也就是说，调用者可以指定0到5个参数中的所有参数。

在MVC4 Beta中，我曾经执行以下操作：

public class BooksController : ApiController
{
    // GET /api/books?author=tolk&title=lord&isbn=91&somethingelse=ABC&date=1970-01-01
    public string GetFindBooks(string author, string title, string isbn, string somethingelse, DateTime? date) 
    {
        // ...
    }
}

MVC4 RC不再具有这种行为。如果我指定的参数少于5个，它会回答404：

在控制器“ Books”上未找到与请求匹配的操作。

不需要在URL路由中指定可选参数的正确方法签名，使其具有与以前一样的行为？

MVC4的常规版本中已解决此问题。现在您可以执行以下操作：

public string GetFindBooks(string author="", string title="", string isbn="", string  somethingelse="", DateTime? date= null) 
{
    // ...
}

一切将立即可用。

可以按照建议将多个参数作为单个模型传递。当您使用FromUri参数属性时，此方法适用于GET。这告诉WebAPI从查询参数填充模型。

结果是只有一个参数的控制器动作更加简洁。有关更多信息，请参见：http : //www.asp.net/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api

public class BooksController : ApiController
  {
    // GET /api/books?author=tolk&title=lord&isbn=91&somethingelse=ABC&date=1970-01-01
    public string GetFindBooks([FromUri]BookQuery query)
    {
      // ...
    }
  }

  public class BookQuery
  {
    public string Author { get; set; }
    public string Title { get; set; }
    public string ISBN { get; set; }
    public string SomethingElse { get; set; }
    public DateTime? Date { get; set; }
  }

只要属性不冲突，它甚至支持多个参数。

// GET /api/books?author=tolk&title=lord&isbn=91&somethingelse=ABC&date=1970-01-01
public string GetFindBooks([FromUri]BookQuery query, [FromUri]Paging paging)
{
  // ...
}

public class Paging
{
  public string Sort { get; set; }
  public int Skip { get; set; }
  public int Take { get; set; }
}

更新：
为了确保值是可选的，请确保对模型属性使用引用类型或可为空（例如int？）。

对所有参数使用初始默认值，如下所示

public string GetFindBooks(string author="", string title="", string isbn="", string  somethingelse="", DateTime? date= null) 
{
    // ...
}

如果要传递多个参数，则可以创建模型而不是传递多个参数。

如果您不想传递任何参数，则也可以在其中跳过，您的代码将看起来整洁。

无法为未声明为' optional'的参数提供默认值

 Function GetFindBooks(id As Integer, ByVal pid As Integer, Optional sort As String = "DESC", Optional limit As Integer = 99)

在你的 WebApiConfig

 config.Routes.MapHttpRoute( _
          name:="books", _
          routeTemplate:="api/{controller}/{action}/{id}/{pid}/{sort}/{limit}", _
          defaults:=New With {.id = RouteParameter.Optional, .pid = RouteParameter.Optional, .sort = UrlParameter.Optional, .limit = UrlParameter.Optional} _
      )