Opcjonalne parametry ciągu zapytania w interfejsie API sieci Web ASP.NET

Muszę zaimplementować następującą metodę WebAPI:

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

Wszystkie parametry ciągu zapytania mogą mieć wartość NULL. Oznacza to, że dzwoniący może określić od 0 do wszystkich 5 parametrów.

W wersji beta MVC4 wykonałem następujące czynności:

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 już się tak nie zachowuje. Jeśli podam mniej niż 5 parametrów, odpowiada to 404powiedzeniem:

Nie znaleziono działania na kontrolerze „Books”, które pasowałoby do żądania.

Jaki jest prawidłowy podpis metody, aby działał tak, jak kiedyś, bez konieczności podawania opcjonalnego parametru w routingu adresu URL?

Ten problem został rozwiązany w regularnej wersji MVC4. Teraz możesz zrobić:

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

i wszystko zadziała po wyjęciu z pudełka.

Możliwe jest przekazanie wielu parametrów jako jednego modelu, jak sugeruje Vijay. Działa to dla GET, gdy używasz atrybutu parametru FromUri. Mówi to interfejsowi WebAPI o wypełnieniu modelu na podstawie parametrów zapytania.

Rezultatem jest czystsze działanie kontrolera z jednym parametrem. Aby uzyskać więcej informacji, zobacz: 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; }
  }

Obsługuje nawet wiele parametrów, o ile właściwości nie powodują konfliktu.

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

Aktualizacja :
Aby upewnić się, że wartości są opcjonalne, należy użyć typów referencyjnych lub wartości zerowych (np. Int?) Dla właściwości modeli.

Użyj początkowych wartości domyślnych dla wszystkich parametrów, takich jak poniżej

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

jeśli chcesz przekazać wiele parametrów, możesz utworzyć model zamiast wielu parametrów.

w przypadku, gdy nie chcesz przekazać żadnego parametru, możesz w nim również pominąć, a kod będzie wyglądał schludnie i czysto.

Nie można podać wartości domyślnych dla parametrów, które nie zostały zadeklarowane ' optional'

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

W Twoim 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} _
      )