CODEWITHSUNDEEP
c#resthttpasp.net-web-api
Ruslan
Ruslan

Reputation: 10147

WebAPI routing: single string parameter

So, according to this:

  • If the parameter is a “simple” type, Web API tries to get the value from the URI. Simple types include the .NET primitive types (int, bool, double, and so forth), plus TimeSpan, DateTime, Guid, decimal, and string, plus any type with a type converter that can convert from a string. (More about type converters later.)
  • For complex types, Web API tries to read the value from the message body, using a media-type formatter.

I have a POST action with a single string parameter coming from the user's input and can therefore be any character - foreign, unicode, apostrophe, '%20' etc. anything!

I am therefore reluctant to have this parameter in the URL and the [FromBody] decorator doesn't appear to be helping. Question is: what is the best [a-hem] pratice for posting a single string parameter to WebAPI controller?

C#:

[HttpPost]
[Route("api/add")]
public void Add([FromBody]string name)
{
    // name is null :(
}

JS:

function add(name: string) {
    return this.$http.post("api/add/", name);
}

enter image description here

Upvotes: 0

Views: 3065

Answers (2)

Ruslan
Ruslan

Reputation: 10147

I have resolved this by wrapping the request object (name) in quotes, using angular.toJson`:

function add(name: string) {
    return this.$http.post("api/add/", angular.toJson(name));
}

Upvotes: 0

Shyju
Shyju

Reputation: 218892

If you really want the [FromBody] decorator, you should consider creating a DTO so that Model binder can read the posted data from the request body and map to this DTO object.

public class MyRequest
{
  public string Name { set;get;}
}

[HttpPost]
[Route("api/add")]
public void Add([FromBody]MyRequest model)
{
    //do something with model.Name
}

If you do not prefer to create a class, you can remove the [FromBody] decorator from your action method and keep a string type and send the value as querystring.

public void Add(string model)
{
    //do something with model.Name
}

and 

$http.post('/api/add?name=Scott with a space')
    .then(function(response) {
        console.log('angular http response', response.data);
    })

Upvotes: 1

Related Questions