Hành vi mặc định là:
Nếu tham số là một nguyên thủy loại (int,bool,double, ...), cố gắng Web API để có được giá trị từ URI của yêu cầu HTTP.
Đối với các loại phức tạp (ví dụ: đối tượng của riêng bạn Person:), API Web cố gắng đọc giá trị từ phần thân của yêu cầu HTTP.
Vì vậy, nếu bạn có:
- một kiểu nguyên thủy trong URI, hoặc
- một loại phức tạp trong cơ thể
... sau đó bạn không phải thêm bất kỳ thuộc tính nào ( [FromBody]cũng không phải[FromUri] ).
Nhưng, nếu bạn có một kiểu nguyên thủy trong cơ thể , thì bạn phải thêm [FromBody]vào trước tham số loại nguyên thủy trong phương thức điều khiển WebAPI của bạn. (Bởi vì, theo mặc định, WebAPI đang tìm kiếm các kiểu nguyên thủy trong URI của yêu cầu HTTP.)
Hoặc, nếu bạn có một loại phức tạp trong URI của mình , thì bạn phải thêm [FromUri]. (Bởi vì, theo mặc định, WebAPI đang tìm kiếm các loại phức tạp trong phần thân của yêu cầu HTTP theo mặc định.)
Các loại nguyên thủy:
public class UsersController : ApiController
{
// api/users
public HttpResponseMessage Post([FromBody]int id)
{
}
// api/users/id
public HttpResponseMessage Post(int id)
{
}
}
Các loại phức tạp:
public class UsersController : ApiController
{
// api/users
public HttpResponseMessage Post(User user)
{
}
// api/users/user
public HttpResponseMessage Post([FromUri]User user)
{
}
}
Điều này hoạt động miễn là bạn chỉ gửi một tham số trong yêu cầu HTTP của mình. Khi gửi nhiều , bạn cần tạo một mô hình tùy chỉnh có tất cả các tham số của bạn như thế này:
public class MyModel
{
public string MyProperty { get; set; }
public string MyProperty2 { get; set; }
}
[Route("search")]
[HttpPost]
public async Task<dynamic> Search([FromBody] MyModel model)
{
// model.MyProperty;
// model.MyProperty2;
}
Từ tài liệu của Microsoft về ràng buộc tham số trong API Web ASP.NET :
Khi một tham số có [FromBody], API Web sử dụng tiêu đề Kiểu nội dung để chọn một trình định dạng. Trong ví dụ này, loại nội dung là "application / json" và thân yêu cầu là một chuỗi JSON thô (không phải là một đối tượng JSON).Nhiều nhất một tham số được phép đọc từ nội dung thư.
Điều này sẽ làm việc:
public HttpResponseMessage Post([FromBody] string name) { ... }
Điều này sẽ không hoạt động:
// Caution: This won't work!
public HttpResponseMessage Post([FromBody] int id, [FromBody] string name) { ... }
Lý do cho quy tắc này là phần thân yêu cầu có thể được lưu trữ trong luồng không được đệm mà chỉ có thể được đọc một lần.