ASP.NET Web API'sında isteğe bağlı sorgu dizesi parametreleri

Aşağıdaki WebAPI yöntemini uygulamak gerekir:

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

Tüm sorgu dizesi parametreleri boş olabilir. Yani, arayan 0 ila 5 parametrenin tümünü belirtebilir.

In MVC4 beta ben aşağıdakileri yapmak için kullanılan:

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 artık böyle davranmıyor. 5'ten az parametre belirtirseniz, bir 404deyimle yanıt verir :

'Kitaplar' denetleyicisinde istekle eşleşen bir eylem bulunamadı.

URL yönlendirmesinde isteğe bağlı parametreyi belirtmeden, eskisi gibi davranmasını sağlamak için doğru yöntem imzası nedir?

Bu sorun, MVC4'ün düzenli sürümünde giderilmiştir. Şimdi şunları yapabilirsiniz:

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

ve her şey kutudan çıkar.

Vijay'in önerdiği gibi tek bir model olarak birden fazla parametre geçirmek mümkündür. FromUri parametre özniteliğini kullandığınızda bu GET için çalışır. Bu, WebAPI'ye modeli sorgu parametrelerinden doldurmasını bildirir.

Sonuç, tek bir parametreyle daha temiz bir denetleyici eylemidir. Daha fazla bilgi için bkz. 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; }
  }

Özellikler çakışmadığı sürece birden fazla parametreyi bile destekler.

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

Güncelleme :
Değerlerin isteğe bağlı olduğundan emin olmak için, model özellikleri için referans türleri veya nullables (örn. İnt?) Kullandığınızdan emin olun.

Aşağıdaki gibi tüm parametreler için başlangıç ​​varsayılan değerlerini kullanın

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

birden fazla parametre iletmek istiyorsanız, birden fazla parametre iletmek yerine model oluşturabilirsiniz.

herhangi bir parametreyi geçmek istemiyorsanız, o zaman içinde de atlayabilirsiniz ve kodunuz düzgün ve temiz görünecektir.

Bildirilmeyen parametreler için varsayılan değerler sağlanamaz ' optional'

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

Sizin 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} _
      )