Changer le nom du paramètre de l'Api Web de la liaison de modèle

Je suis à l'aide de l'API Web de la liaison de modèle pour analyser les paramètres de la requête à partir d'une URL. Par exemple, voici un modèle de classe:

public class QueryParameters
{
    [Required]
    public string Cap { get; set; }

    [Required]
    public string Id { get; set; }
}

Cela fonctionne très bien quand je l'appelle quelque chose comme /api/values/5?cap=somecap&id=1.

Est-il une manière que je peux changer le nom de la propriété dans la classe du modèle, mais de garder la requête de paramètre nom de la même - par exemple:

public class QueryParameters
{
    [Required]
    public string Capability { get; set; }

    [Required]
    public string Id { get; set; }
}

J'ai pensé à l'ajout de [Display(Name="cap")] à la Capability de la propriété, mais il ne le fait pas. Est-il un type d'annotation de données que je devrais utiliser?

Le contrôleur est une méthode qui ressemblait à ceci:

public IHttpActionResult GetValue([FromUri]QueryParameters param)    
{
    //Do Something with param.Cap and param.id
}

OriginalL'auteur user1763965 | 2014-10-28

  1. 18

    Vous pouvez utiliser la propriété Name de la FromUri de liaison de l'attribut à utiliser les paramètres de chaîne de requête avec des noms différents pour les arguments de la méthode.

    Si vous passez des paramètres simples plutôt que votre QueryParameters type, vous pouvez lier les valeurs comme ceci:

    /api/values/5?cap=somecap&id=1

public IHttpActionResult GetValue([FromUri(Name = "cap")] string capabilities, int id)    
{
}

    OriginalL'auteur Paul Taylor

  2. 11

    API Web utilise un peu mécanisme différent pour le modèle de liaison de ASP.NET MVC. Il utilise des formateurs pour les données transmises dans le corps et classeurs de modèle pour les données transmises dans la chaîne de requête (comme dans votre cas). Formateurs des attributs de métadonnées tandis que le modèle de liants ne le font pas.

    Donc, si vous avez passé votre modèle dans le corps du message plutôt que de la chaîne de requête, vous pouvez annoter vos données comme suit et il devrait fonctionner:

    public class QueryParameters
{
    [DataMember(Name="Cap")]
    public string Capability { get; set; }

    public string Id { get; set; }
}

    Vous connaissez sans doute déjà. Pour qu'il fonctionne avec des paramètres de chaîne de requête et, par conséquent, le modèle de classeur que vous auriez à utiliser votre propre modèle de classeur qui serait en fait inspecter et d'utiliser DataMember attributs.

    Le morceau de code suivant ferait l'affaire (même si c'est loin de la qualité de la production):

    public class MemberModelBinder : IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        var model = Activator.CreateInstance(bindingContext.ModelType);
        foreach (var prop in bindingContext.PropertyMetadata)
        {
            //Retrieving attribute
            var attr = bindingContext.ModelType.GetProperty(prop.Key)
                                     .GetCustomAttributes(false)
                                     .OfType<DataMemberAttribute>()
                                     .FirstOrDefault();
            //Overwriting name if attribute present
            var qsParam = (attr != null) ? attr.Name : prop.Key;
            //Setting value of model property based on query string value
            var value = bindingContext.ValueProvider.GetValue(qsParam).AttemptedValue;
            var property = bindingContext.ModelType.GetProperty(prop.Key);
            property.SetValue(model, value);
        }
        bindingContext.Model = model;
        return true;
    }
}

    Vous devrez également indiquer dans votre méthode de contrôleur que vous souhaitez utiliser ce modèle de classeur:

    public IHttpActionResult GetValue([ModelBinder(typeof(MemberModelBinder))]QueryParameters param)
    +1 Fonctionne pour moi, bien que je ne marquée DataMember attribut sur les propriétés avec les noms de paramètres qui sont différentes de nom de propriété. Par conséquent, j'ai dû le séparer de la méthode GetValue appel et AttemptedValue de référence, et à la place de null vérifier sur la propriété, sinon vous risquez une exception NullReferenceException. Probablement pas une mauvaise idée, peu importe 🙂

    OriginalL'auteur Sebastian K

  3. 0

    J'ai passé plusieurs heures à travailler sur une solution robuste pour le même problème, quand un one-liner fera l'affaire parfaitement: 

    myModel.Capability = HttpContext.Current.Request["cap"];
    HttpContext.Actuel.Demande["clé"] sera toujours juste de retour d'une chaîne.

    OriginalL'auteur user2966445

  4. 0

    Je viens de croiser et d'une lecture dans ma classe de paramètre de retour de la limite de propriété.

    Donc dans votre exemple:

    public class QueryParameters
{
    public string cap {get; set;}
    public string Capability
    {
      get { return cap; }
    }

    public string Id { get; set; }
}

    Maintenant dans votre Contrôleur, vous pouvez faire référence à la Capability propriété.

    public IHttpActionResult GetValue([FromUri]QueryParameters param)    
{
    //Do Something with param.Capability,
    //except assign it a new value because it's only a getter
}

    Bien sûr, si vous utilisez une réflexion sur la param objet ou sérialiser les cap propriété sera inclus. Je ne sais pas pourquoi quelqu'un aurait besoin de le faire qu'avec les paramètres de la requête.

    si param nom est '$cap pas cap'?

    OriginalL'auteur pholly