Adding parameters and backward compatibility?

Question

Using WebAPI I have a restful service.

public SomeValue GetSomeValue()
{
}

I need to now pass in a string, but it's optional and a default value is fine:

public SomeValue GetSomeValue(string language="EN")
{
}

Will old clients that I can't update send a call just to GetSomeValue() still work, with a default value sent in? Or do I need to create a second method GetSomeValueForLanguage(string language) with GetSomeValue() calling it internally?

Can you try it in a test environment?

mellamokb
– mellamokb

2014-04-09 22:24:22 +00:00
Commented Apr 9, 2014 at 22:24 — mellamokb
– mellamokb, Commented Apr 9, 2014 at 22:24

Russ Cam · Accepted Answer · 2014-04-09 22:25:16Z

2

Change the method to take a default string parameter; old clients will be able to call it fine still, assuming your routing is staying the same (in which case language will be appended to the query string). If you're adding language as a route token, ensure that it's optional on the route such that the default parameter value for the action is used.

answered Apr 9, 2014 at 22:25

Russ Cam

126k34 gold badges211 silver badges275 bronze badges

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

Comments

Will Wang · Accepted Answer · 2014-04-10 01:45:00Z

0

you can try this:

public classs  MyParams
{
   public string language{set;get;}
}

then change you method to this:

public SomeValue GetSomeValue([FromBody] MyParams obj)
{
     if(String.IsNullOrEmpty(obj.language) obj.language="en";
     //you code
}

if your HTTP method is GET, you shall use FormUrl attribute instead of FromBody attribute

answered Apr 10, 2014 at 1:45

Will Wang

5375 silver badges7 bronze badges

Collectives™ on Stack Overflow

Adding parameters and backward compatibility?

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related