Paramètres de chaîne de requête facultatifs dans l'API Web ASP.NET

J'ai besoin d'implémenter la méthode WebAPI suivante:

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

Tous les paramètres de chaîne de requête peuvent être nuls. Autrement dit, l'appelant peut spécifier de 0 à tous les 5 paramètres.

Dans MVC4 beta, j'avais l'habitude de faire ce qui suit:

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 ne se comporte plus comme ça. Si je spécifie moins de 5 paramètres, il répond par un 404dicton:

Aucune action n'a été trouvée sur les livres du contrôleur qui correspond à la demande.

Quelle est la signature de méthode correcte pour qu'elle se comporte comme avant, sans avoir à spécifier le paramètre facultatif dans le routage URL?

Ce problème a été corrigé dans la version régulière de MVC4. Vous pouvez maintenant:

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

et tout fonctionnera hors de la boîte.

Il est possible de passer plusieurs paramètres en un seul modèle comme l'a suggéré vijay. Cela fonctionne pour GET lorsque vous utilisez l'attribut de paramètre FromUri. Cela indique à WebAPI de remplir le modèle à partir des paramètres de requête.

Le résultat est une action de contrôleur plus propre avec un seul paramètre. Pour plus d'informations, voir: 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; }
  }

Il prend même en charge plusieurs paramètres, tant que les propriétés ne sont pas en conflit.

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

Mise à jour :
Afin de garantir que les valeurs sont facultatives, assurez-vous d'utiliser des types de référence ou des valeurs Nullables (ex. Int?) Pour les propriétés des modèles.

Utiliser les valeurs par défaut initiales pour tous les paramètres comme ci-dessous

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

si vous voulez passer plusieurs paramètres, vous pouvez créer un modèle au lieu de passer plusieurs paramètres.

dans le cas où vous ne voulez pas passer de paramètre, vous pouvez également l'ignorer et votre code sera net et propre.

Les valeurs par défaut ne peuvent pas être fournies pour les paramètres qui ne sont pas déclarés ' optional'

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

Dans votre 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} _
      )