Типова поведінка:
Якщо параметр є примітивним типом ( int, bool, double...), Web API намагається отримати значення з URI запиту HTTP.
Для складних типів (власний об'єкт, наприклад Person:) Web API намагається прочитати значення з тіла HTTP-запиту.
Отже, якщо у вас є:
- примітивний тип в URI, або
- складного типу в організмі
... тоді вам не доведеться додавати атрибути (ні те, ні [FromBody] ані [FromUri]).
Але, якщо у вас в організмі примітивний тип , вам доведеться додати [FromBody]перед своїм параметром примітивний тип у своєму методі контролера WebAPI. (Тому що за замовчуванням WebAPI шукає примітивні типи в URI запиту HTTP.)
Або, якщо у вас є складний тип у вашій URI , то ви повинні додати [FromUri]. (Тому що за замовчуванням WebAPI шукає складні типи в тілі запиту HTTP за замовчуванням.)
Первісні типи:
public class UsersController : ApiController
{
// api/users
public HttpResponseMessage Post([FromBody]int id)
{
}
// api/users/id
public HttpResponseMessage Post(int id)
{
}
}
Складні типи:
public class UsersController : ApiController
{
// api/users
public HttpResponseMessage Post(User user)
{
}
// api/users/user
public HttpResponseMessage Post([FromUri]User user)
{
}
}
Це працює, поки ви надсилаєте лише один параметр у своєму HTTP-запиті. При надсиланні декількох вам потрібно створити власну модель, у якій є всі ваші параметри:
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;
}
З документації Microsoft щодо прив'язки параметрів у веб-API ASP.NET :
Коли параметр має [FromBody], веб-API використовує заголовок Content-Type для вибору форматера. У цьому прикладі тип вмісту - "application / json", а тіло запиту - це необроблена рядок JSON (не об'єкт JSON). Щонайменше один параметр дозволяється читати з тіла повідомлення.
Це має працювати:
public HttpResponseMessage Post([FromBody] string name) { ... }
Це не вийде:
// Caution: This won't work!
public HttpResponseMessage Post([FromBody] int id, [FromBody] string name) { ... }
Причиною цього правила є те, що тіло запиту може зберігатися в небуферизованому потоці, який можна прочитати лише один раз.