В шаблоне для Web API 2 метод публикации всегда выглядит следующим образом:
[ResponseType(typeof(MyDTO))]
public IHttpActionResult PostmyObject(MyDTO myObject)
{
...
return CreatedAtRoute("DefaultApi", new { id = myObject.Id }, myObject);
}
Я не понимаю этого CreatedAtRoute() метода. Может ли кто-нибудь объяснить мне метод CreatedAtRoute()?
Метод CreatedAtRoute предназначен для возврата URI к вновь созданному ресурсу, когда вы вызываете метод POST для хранения некоторого нового объекта. Поэтому, если вы, например, ПУБЛИВАЕТЕ элемент заказа, вы можете вернуть такой маршрут, как «api / order / 11» (11, очевидно, является идентификатором заказа).
Кстати, я согласен, что статья MSDN бесполезна для понимания этого. Маршрут, по которому вы действительно вернетесь, будет, естественно, зависеть от вашей настройки маршрутизации.
[Route("[controller]")] на контроллере, что я возвращаю (чтобы, например, можно было вызвать соседнее действие GET с URL-адресом)?
- person Shimmy Weitzhandler; 22.12.2017
"[controller]" работает вне Route() :(
- person Lucas; 27.03.2021
Когда вы используете CreatedAtRoute, первым аргументом является имя метода Get to the resource. Уловка, которая не так очевидна, заключается в том, что даже при указании правильного имени метода вы должны использовать параметр Name в атрибуте HttpGet, чтобы он работал.
Итак, если ответ в вашем сообщении такой:
return CreatedAtRoute("Get", new { newModel.Id}, newModel);
Тогда ваш атрибут метода Get должен выглядеть так, даже если ваш метод называется Get:
[HttpGet("{id}", Name = "Get")]
Вызов вашего метода Post не только вернет новый объект (обычно как JSON), но и установит заголовок Location в ответ на URI, который получит этот ресурс.
В WebAPI ядра .NET вы используете этот метод для возврата кода 201, что означает, что объект был создан.
[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.CreatedAtRouteResult CreatedAtRoute (string routeName, object routeValues, object content);
Как видно выше, CreatedAtRoute может получать 3 параметра:
routeName - это имя, которое вы должны присвоить методу, который будет URI, который получит этот ресурс после создания.
routeValues . Это объект, содержащий значения, которые будут переданы методу GET на указанном маршруте. Он будет использоваться для возврата созданного объекта
содержание Это созданный объект.
В приведенном выше примере показана реализация двух методов простого контроллера с простым методом GET со связанным именем и методом POST, который создает новый объект.
namespace BastterAPI.Controllers
{
[Route("api/[controller]")]
[ApiController]
public class CompanyController : Controller
{
private ICompanyRepository _companyRepository;
public CompanyController(ICompanyRepository companyRepository)
{
_companyRepository = companyRepository;
}
[HttpGet("{id}", Name="GetCompany")]
public IActionResult GetById(int id)
{
Company company = _companyRepository.Find(id);
if (company == null)
{
return NotFound();
}
return new ObjectResult(company);
}
[HttpPost]
public IActionResult Create([FromBody] Company company)
{
if (company == null)
{
return BadRequest();
}
_companyRepository.Add(company);
return CreatedAtRoute("GetCompany", new Company { CompanyID = company.CompanyID }, company);
}
}
}
ВАЖНО
Обратите внимание, что первый параметр в CreatedAtRoute (routeName) должен совпадать с определением Name в методе Get.
Объект во втором параметре должен будет иметь необходимые поля, которые вы используете для извлечения ресурса в методе Get, вы можете сказать, что это подмножество объекта, созданного самим.
Последний параметр - это объект компании, полученный в теле запроса в его полной форме.
ЗАВЕРШЕНИЕ
В конечном итоге, когда сообщение о создании новой компании будет добавлено в этот API, вы вернете маршрут вроде «api / company / {id}», который вернет вам вновь созданный ресурс.
