ASP.NET Web API model binding - different parameters names

Question

Is it possible to map parameters from request to properties with different names? I need it because I'd like to use words splitted by underscore as url parameters but in C# code I'd like to use normal convention. Example :

?property_name=1 to property PropertyName

In the request I use [FromUri] parameter like

public IHttpActionResult DoMethod([FromUri(Name = "")] SomeInput input)

Initially I thought that model binding is performed by Json serializer but probably it isn't. I tried DataMember attribute as well but these approaches do not work.

public class SomeInput
{
    [JsonProperty("property_name")]
    [DataMember(Name = "property_name")]
    public int PropertyName { get; set; }
}

I read about the custom binders but I hope some more simple way must exist. Any idea how to do this correctly and simple in ASP.NET Web API 2 with using Owin and Katana?

Did you make some changes in your web api configuration? like: formatters, converters etc — MaKCbIMKo
– MaKCbIMKo, Commented May 2, 2016 at 15:38
Does this answer your question? Changing the parameter name Web Api model binding This answer specifically worked for me: stackoverflow.com/a/29090053/5815327 — Deantwo
– Deantwo, Commented Aug 28, 2020 at 7:00

Dan Harms · Accepted Answer · 2016-05-02 16:14:03Z

4

You can do a remapping for an individual parameter using the Name property on [FromUri]:

public IHttpActionResult DoMethod([FromUri(Name = "property_name")] int propertyName)

To remap inside a custom object you will need to create a model binder.

answered May 2, 2016 at 16:14

Dan Harms

4,8702 gold badges21 silver badges30 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

y0j0 Over a year ago

It is no solution. I have multiple properties inside SomeInput. I use only simplified code in this example.

Dan Harms Over a year ago

You can do this for as many properties as you'd like. Obviously, it's tedious with a lot of fields.

y0j0 Over a year ago

Yes yo're right but I have more things in wrapping object SomeInput like validations, comments to generate documentation etc.

Dan Harms Over a year ago

You can always build that object with these fields.

Zameel · Accepted Answer · 2022-11-22 07:44:18Z

0

In your model you could do something like this.

using Microsoft.AspNetCore.Mvc;

public class SomeInput
{
  [FromQuery(Name = "property_name")]
  public string PropertyName {get; set;}
    
}

Then in your controller get method access it from the mapped name

[HttpGet]
public IHttpActionResult DoMethod([FromQuery]SomeInput someInput)
{
 someInput.PropertyName 
 ...
}

answered Nov 22, 2022 at 7:44

Zameel

112 bronze badges

Collectives™ on Stack Overflow

ASP.NET Web API model binding - different parameters names

2 Answers 2

4 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related