En option paramètres de chaîne de requête dans ASP.NET Web API

J'ai besoin pour mettre en œuvre les suivantes WebAPI méthode:

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

Tous les paramètres de chaîne de requête peut être null. Qui est, l'appelant peut spécifier de 0 à tous les 5 paramètres.

Dans MVC4 bêta j'ai utilisé pour effectuer les opérations suivantes:

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 comportent pas comme ça. Si je spécifiez moins de 5 paramètres, il répond avec un 404 disant:

Aucune action n'a été trouvé sur le contrôleur "Livres" qui correspond à la demande.

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

  • mettre [httpget] sur l'action.
  • Si j'ai mis tous les paramètres de la méthode est appelée; en outre, il commence avec Get il est automatiquement lié avec le HTTP GET méthode...
  • C'est la manière dont le web api travaux de routage, asp.net/web-api/overview/web-api-routing-and-actions/...
  • Oui. Je sais comment il fonctionne. Je ne peux pas le faire fonctionner en vertu de CETTE circonstance particulière.
  • Comment cette même compiler? string? n'est pas un type valide. Vous ne pouvez pas déclarer string comme type nullable, car il est un type de référence.
  • vous avez raison, c'était probablement un rapide résumé de code que j'ai écrit juste dans le but de comprendre pourquoi je n'étais pas en mesure de défaut de null. Je me rappelle que le vrai problème était avec DateTime qui ne pouvaient pas être en défaut jusqu'à ce que la version bêta. Aussi, cette question est à partir de 1 an et demi.

InformationsquelleAutor frapontillo | 2012-08-08
  1. 297

    Ce problème a été corrigé dans la diffusion régulière de MVC4.
    Maintenant vous pouvez le faire:

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

    et tout va fonctionner hors de la boîte.

    • Puis-je utiliser null ici comme un défaut? Par exemple: string author=null ?
    • Oui, null est considéré comme un expression constante, et donc un valeur par défaut valide.
    • Je me demande pourquoi nous devons mentionner les valeurs par défaut, même pour les paramètres facultatifs comme l'a dit ici . N'importe quel type en C# de toujours avoir une valeur par défaut donc de routage au moment de l'exécution pourrait avoir le type de la valeur par défaut si elle ne l'a pas reçu à partir de l'URI. Qu'est-ce que la technique la raison derrière tout cela?. Je suis sûr que cela a quelque chose à voir avec le modèle de classeur.
    • Pour que l'itinéraire peut être adapté
    • J'ai été en utilisant les paramètres de date et si je viens de le configurer pour accepter les valeurs null ne fonctionnait pas. J'ai donc à définir les valeurs null et le set null comme valeur par défaut, et l'utilisation côté serveur de validation en conséquence et de retour des messages d'erreur en retour. Il a travaillé.
    InformationsquelleAutor frapontillo
  2. 77

    Il est possible de passer plusieurs paramètres, comme modèle unique, comme vijay suggéré. Cela fonctionne pour OBTENIR lorsque vous utilisez le FromUri attribut de paramètre. Cela dit WebAPI pour remplir le modèle de paramètres de requête.

    Le résultat est un nettoyeur de contrôleur de l'action 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 de plusieurs paramètres, tant que les propriétés n'entrent 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 s'assurer que les valeurs sont en option assurez-vous d'utiliser les types de référence ou nullable (ex. int?) pour les modèles de propriétés.

    • Oui, mais le [FromUri] décorateur à lui seul ne semble pas soutenir des paramètres facultatifs.
    • Vous êtes à la corriger à l'aide de [FromUri] ne pas répondre directement à la question d'origine. Il dit en substance remplir ces modèles avec les valeurs à partir de l'Uri. Les modèles de propriétés doivent être nullable ou un type de référence afin de la soutenir facultative. Ajout d'informations supplémentaires.
    • Pourriez-vous élaborer sur quand et pourquoi vous avez besoin d'utiliser nullable afin que les valeurs sont en option? Si vous ne faites pas les valeurs nullable (par ex, la propriété int Skip) et il n'ya pas de requête de paramètre pour que la propriété est spécifiée, l'API Contrôleur méthode encore réussi à faire correspondre la demande et de la valeur de Skip sera juste la valeur par défaut pour ce type, ou 0 dans ce cas
    • Sans l'aide d'un type nullable vous ne savez pas si l'utilisateur n'a pas fourni une valeur et a obtenu le non initialisée type de valeur (0 pour int) ou si l'utilisateur a spécifié 0. En utilisant les valeurs null, vous êtes sûr de l'utilisateur de gauche indéfini, par conséquent, vous pouvez appliquer en toute sécurité par défaut dans le contrôleur de l'action. Si vous cherchez à Prendre à partir de l'exemple ci-dessus, ce qui devrait l'action si elle a reçu un 0 pour les Prendre? L'utilisateur a moyen de demander à 0 enregistrements ou n'ont-ils pas le spécifier et, par conséquent, vous devez prendre tous les records. En général, si vous voulez un type de valeur (int, bool, etc.) pour être en option, alors il devrait être nullable.
    InformationsquelleAutor Andrew C
  3. 66

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

    public string GetFindBooks(string author="", string title="", string isbn="", string  somethingelse="", DateTime? date= null) 
{
    //...
}
    • C'est la procédure correcte mais pour une chose: DateTime n'est pas les valeurs null. J'ai déjà essayé d'utiliser DateTime? à la place, mais ensuite, MVC n'a pas la carte de la demande à la méthode donnée si j'ai mis uniquement à certains paramètres dans ma requête HTTP.
    • vous pouvez passer la date sous forme de chaîne et de l'analyser à l'intérieur de votre fonction de contrôleur de l'aide DateTime.Parse() de la fonction.
    • n'est pas un nullable type de données. Votre code ne devrait pas compiler, que vous ne seriez pas en mesure d'assigner une null de la valeur à un paramètre de type DateTime. Peut-être, vous devez la modifier pour DateTime?, ou utiliser une valeur différente pour un défaut comme DateTime.Now.
    • DateTime.Maintenant n'est pas une compilation constante de temps de sorte qu'il ne peut pas être affecté en tant que paramètre par défaut.
    • vous avez bien raison. Datetime.Now ne peut pas être utilisé dans les paramètre par défaut de l'initialisation, je corrige la position des mains.
    InformationsquelleAutor Muhammad Amin
  4. 1

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

    dans le cas où vous ne voulez pas passer n'importe quel paramètre, alors vous pouvez ignorer en tant que bien, et votre code a l'air soigné et propre.

    • Ceci n'est vrai que pour le POSTE de paramètres dans le corps de la requête - paramètres dans l'url peut être encore référence individuellement en tant qu'arguments.
    InformationsquelleAutor vijay
  5. 1

    Les valeurs par défaut ne peuvent pas être fournis 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} _
      )
    • En fait, ils le peuvent. Je suis à l'aide de C#, pas VB.NET.
    InformationsquelleAutor Rizwan Mumtaz