如何将 json POST 数据作为对象传递给 Web API 方法？

ASP.NET MVC4 Web API 应用程序定义了 post 方法来保存客户。 客户在 POST 请求正文中以 json 格式传递。 post 方法中的客户参数包含属性的空值。

如何解决此问题以便发布的数据将作为客户对象传递？

如果可能的话，应该使用Content-Type: application/x-www-form-urlencoded，因为我不知道如何在发布表单的javascript方法中更改它。

控制器：

public class CustomersController : ApiController {

  public object Post([FromBody] Customer customer)
        {
            return Request.CreateResponse(HttpStatusCode.OK,
            new
            {
                customer = customer
            });
        }
    }
}

public class Customer
    {
        public string company_name { get; set; }
        public string contact_name { get; set; }
     }

Request:

POST http://localhost:52216/api/customers HTTP/1.1
Accept: application/json, text/javascript, */*; q=0.01
X-Requested-With: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

{"contact_name":"sdfsd","company_name":"ssssd"}

EDIT: 2017 年 10 月 31 日

相同的代码/方法适用于Asp.Net核心2.0以及。主要区别在于，在 asp.net core 中，Web api 控制器和 Mvc 控制器都合并到单个控制器模型中。所以你的返回类型可能是IActionResult或其实现之一（例如：OkObjectResult)

Use

contentType:"application/json"

你需要使用JSON.stringify发送时将其转换为 JSON 字符串的方法，

模型绑定器会将 json 数据绑定到您的类对象。

下面的代码可以正常工作（已测试）

$(function () {
    var customer = {contact_name :"Scott",company_name:"HP"};
    $.ajax({
        type: "POST",
        data :JSON.stringify(customer),
        url: "api/Customer",
        contentType: "application/json"
    });
});

Result

contentType属性告诉服务器我们正在以 JSON 格式发送数据。由于我们发送了 JSON 数据结构，模型绑定将会正确发生。

如果您检查 ajax 请求的标头，您可以看到Content-Type值设置为application/json.

如果您没有显式指定 contentType，它将使用默认的内容类型application/x-www-form-urlencoded;

2015 年 11 月编辑以解决评论中提出的其他可能问题

发布一个复杂的对象

假设您有一个复杂的视图模型类作为您的 Web api 操作方法参数，如下所示

public class CreateUserViewModel
{
   public int Id {set;get;}
   public string Name {set;get;}  
   public List<TagViewModel> Tags {set;get;}
}
public class TagViewModel
{
  public int Id {set;get;}
  public string Code {set;get;}
}

你的 web api 端点就像

public class ProductController : Controller
{
    [HttpPost]
    public CreateUserViewModel Save([FromBody] CreateUserViewModel m)
    {
        // I am just returning the posted model as it is. 
        // You may do other stuff and return different response.
        // Ex : missileService.LaunchMissile(m);
        return m;
    }
}

在撰写本文时，ASP.NET MVC 6 是最新的稳定版本，在 MVC6 中，Web api 控制器和 MVC 控制器都继承自Microsoft.AspNet.Mvc.Controller基类。

要将数据从客户端发送到方法，下面的代码应该可以正常工作

//Build an object which matches the structure of our view model class
var model = {
    Name: "Shyju",
    Id: 123,
    Tags: [{ Id: 12, Code: "C" }, { Id: 33, Code: "Swift" }]
};

$.ajax({
    type: "POST",
    data: JSON.stringify(model),
    url: "../product/save",
    contentType: "application/json"
}).done(function(res) {       
    console.log('res', res);
    // Do something with the result :)
});

模型绑定适用于某些属性，但不是全部！为什么 ？

如果你不使用修饰web api方法参数[FromBody]属性

[HttpPost]
public CreateUserViewModel Save(CreateUserViewModel m)
{
    return m;
}

并发送模型（原始 javascript 对象，不是 JSON 格式）而不指定 contentType 属性值

$.ajax({
    type: "POST",
    data: model,
    url: "../product/save"
}).done(function (res) {
     console.log('res', res);
});

模型绑定适用于模型上的平面属性，不适用于类型为复杂/其他类型的属性。在我们的例子中，Id and Name属性将正确绑定到参数m, 但是Tags属性将是一个空列表。

如果您使用短版本也会出现同样的问题，$.post发送请求时将使用默认的 Content-Type。

$.post("../product/save", model, function (res) {
    //res contains the markup returned by the partial view
    console.log('res', res);
});