任何人都可以向我解释CreateAtRoute（）吗？

Question

从Web API 2的模板中，post方法总是这样的：

[ResponseType(typeof(MyDTO))]
public IHttpActionResult PostmyObject(MyDTO myObject)
{
    ...
    return CreatedAtRoute("DefaultApi", new { id = myObject.Id }, myObject);
}

我不理解这个< code>CreatedAtRoute()方法。有人能给我解释一下吗？

Answer 1

在.net core WebAPI中，使用此方法返回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方法。

[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 { id = company.CompanyID },
            company);
    }
}

重要的

>

请注意，CreatedAtRoute（routeName）中的第一个参数必须与Get方法中Name的定义相同。

第二个参数上的对象需要有必要的字段，您可以使用这些字段来检索Get方法上的资源，您可以说它是自己创建的对象的子集

最后一个参数是在主体请求中接收的完整形式的公司对象。

最终

最终结果是，当创建新公司的帖子发送到此API时，您将返回一个类似“API/company/｛id｝”的路由，该路由将返回新创建的资源

Answer 2

当您使用< code>CreatedAtRoute时，第一个参数是资源的< code>GET的路由名称。不太明显的技巧是，即使指定了正确的方法名，也必须在HttpGet属性上使用Name param才能使它工作。

因此，如果您的< code >帖子中的回复是这样的:

return CreatedAtRoute("Get", routeValues: new { id = model.Id }, value: model);

那么即使方法名为Get，Get方法属性也应该如下所示：

[HttpGet("{id}", Name = "Get")]

对Post方法的调用不仅会返回新的对象(通常是JSON)，还会在对获取资源的URI的响应中设置位置头。

注意routeValue字段名称中的字段名称需要与目标路由中的绑定名称匹配，即需要有一个名为id的字段来匹配{id}在HttpGet（"{id}"

最后，在某些情况下，应该提到CreatedAtAction助手可以是更直接的解决方案。

Answer 3

CreatedAtRoute方法旨在在您调用POST方法来存储一些新对象时将URI返回到新创建的资源。因此，例如，如果您POST一个订单项，您可能会返回像'api/order/11'这样的路由（11显然是订单的id）。

顺便说一句，我同意MSDN文章在理解这一点方面没有用处。您实际返回的路线自然取决于您的路由设置。