关于c＃：有人可以向我解释CreatedAtRoute()吗？

Can anyone explain CreatedAtRoute() to me?

在Web API 2的模板中，post方法始终像这样：

1
2
3
4
5
6

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

我不明白这种CreatedAtRoute()方法。谁能向我解释CreatedAtRoute()方法？

相关讨论

谢谢。这非常有帮助。但是，当我在Postman上进行测试时，我看到返回的是myObject，而不是路由？
它返回的实际上是一个CreatedAtRouteNegotiatedContentResult 对象！如果您对自己的操作进行单元测试，那么您将看到这些。但是，在http上下文中运行时，它将在正文中返回序列化的对象，但是您应该在响应中看到带有资源链接的标头。顺便说一句，如果您认为我回答了这个问题，您可以标记为答案吗？干杯。
谢谢，这回答了我的问题。
您提供的路由在响应中显示为"位置"标头。这是相当典型的REST行为
为什么我必须在CreatedAtRoute中返回MyObject，它已经在客户端上了呢……只有Id是新的，它已经是匿名类型了！
@Elisa：MyObject不是由CreatedAtRoute返回的-只是新资源的URI。这将包括客户端尚不知道的ID(至少在数据库生成ID的典型情况下)，这是该方法的主要目的。 REST的标准是在发布新资源时返回该标准，但这不是强制性的或其他任何要求。如果您不需要它，则可以返回201。
@seesharper当未返回MyObject时...为什么我必须将其传递给CreatedAtRoute？方法是什么？
好的，这样的答案可以回答简单案例的问题，但是复杂案例呢？当我要返回的URI是/ api / Customers / {customerId} / Order / {orderId}时，如何调用CreatedAtRoute？
这是指向CreatedAtRoute的一个相关问题的另一个链接，该问题讨论使用属性时的路由命名(即，针对复杂的路由，例如我给的客户示例。)它通过填写两个参数解决了我的问题。
有没有办法使用当前路线？例如，如果我使用控制器上的[Route("[controller]")]在文件控制器中创建对象，该返回什么(例如，可以使用URL调用相邻的GET操作)？
@seesharper，在回复伊丽莎白时，您说MyObject不是CreatedAtRoute返回的。尽管您之前在此线程中发表过评论，但您说它是在体内以序列化形式返回的。你能澄清一下吗？我是否正确认为资源的URI和资源本身(在主体中)都从CreatedAtRoute调用传递回客户端？如果是这样，将两者都包括在内有什么意义？
@RuneStar好问题。自从我编写此答案以来已经有很长时间了，而且我已经有一段时间没有使用Web API了，但是是的，CreatedAtRoute返回该位置作为标头以及对象本身在正文中。因此，似乎对伊丽莎白的评论是错误的。关于目的，我的猜测是，对于POST请求(与PUT相对)，服务器可能创建的对象不仅是客户端发送的对象，而且客户端可能对此感兴趣，而不希望必须对返回的位置URI进行第二次请求。
我是否应该理解CreatedAtRoute返回创建的对象以及指向Get方法的链接。我本来以为返回的对象是通过调用Get方法产生的。

当您使用CreatedAtRoute时，第一个参数是Get to the resource的方法名称。不太明显的诀窍是，即使指定了正确的方法名称，也必须在HttpGet属性上使用Name参数才能使其正常工作。

因此，如果您的帖子中的退货是这样的：

1	return CreatedAtRoute("Get", new { newModel.Id}, newModel);

然后，即使您的方法名为Get，您的Get方法属性也应如下所示：

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

调用Post方法不仅会返回新对象(通常为JSON)，还会在响应的URI上设置Location标头，以获取该资源。

相关讨论

在.net核心WebAPI中，您使用此方法返回201代码，这意味着已创建对象。

1 2	[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方法。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

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)上的第一个参数必须与Get方法的Name定义相同。

第二个参数上的对象将需要具有用于获取Get方法上的资源所必需的字段，可以说这是自身创建的对象的子集

最后一个参数是在正文请求中以完整格式收到的公司对象。

最终

最终结果是，当创建新公司的邮政使用此API时，您将返回一条路由，例如" api / company / {id}"，这将返回给您新创建的资源