Các tham số chuỗi truy vấn tùy chọn trong ASP.NET Web API

Tôi cần triển khai phương pháp WebAPI sau:

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

Tất cả các tham số chuỗi truy vấn có thể là null. Nghĩa là, người gọi có thể chỉ định từ 0 đến tất cả 5 tham số.

Trong MVC4 beta, tôi đã từng làm như sau:

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 không hoạt động như thế này nữa. Nếu tôi chỉ định ít hơn 5 tham số, nó sẽ trả lời bằng một 404câu:

Không có hành động nào được tìm thấy trên bộ điều khiển 'Sách' phù hợp với yêu cầu.

Chữ ký phương thức chính xác để làm cho nó hoạt động như trước đây mà không phải chỉ định tham số tùy chọn trong định tuyến URL là gì?

Vấn đề này đã được khắc phục trong bản phát hành thường xuyên của MVC4. Bây giờ bạn có thể làm:

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

và mọi thứ sẽ làm việc ra khỏi hộp.

Có thể truyền nhiều tham số dưới dạng một mô hình như vijay đề xuất. Điều này hoạt động cho GET khi bạn sử dụng thuộc tính tham số FromUri. Điều này báo cho WebAPI điền vào mô hình từ các tham số truy vấn.

Kết quả là một hành động điều khiển sạch hơn chỉ với một tham số duy nhất. Để biết thêm thông tin, hãy xem: 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; }
  }

Nó thậm chí còn hỗ trợ nhiều tham số, miễn là các thuộc tính không xung đột.

// 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; }
}

Cập nhật :
Để đảm bảo các giá trị là tùy chọn, hãy đảm bảo sử dụng các loại tham chiếu hoặc nullables (ví dụ: int?) Cho các thuộc tính mô hình.

Sử dụng các giá trị mặc định ban đầu cho tất cả các tham số như bên dưới

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

Nếu bạn muốn truyền nhiều tham số thì bạn có thể tạo mô hình thay vì truyền nhiều tham số.

trong trường hợp bạn không muốn vượt qua bất kỳ tham số nào thì bạn cũng có thể bỏ qua nó và mã của bạn sẽ trông gọn gàng và sạch sẽ.

Các giá trị mặc định không thể được cung cấp cho các tham số không được khai báo ' optional'

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

Trong bạn 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} _
      )