ASP.NET API 路由

Question

我正在研究 ASP.NET 5 API 并了解到，为了尽可能使 API 成为 "restful"，我们使用 Http 动词作为方法名称。

我的问题是，如果我有多个方法执行不同的操作并且都必须是 HttpPost，会发生什么？

比如说，我有一个方法可以调用来更新用户的名字，并且可能有另一个方法可以用来更新用户的城市。在这两种情况下，输入参数都是用户 ID (GUID) 和字符串值。

[HttpPost("id")]
public void Post([FromRoute]id, [FromBody]firstName)
{
   // Change user's first name
}

[HttpPost("id")]
public void Post([FromRoute]id, [FromBody]city)
{
   // Change user's city
}

在这种情况下如何命名我的方法？

Answer 1

要有 2 个 post 方法做不同的事情，请使用 "ActionName" 属性。

[HttpPost("id")]
[ActionName("FirstNamePost")]
public void FirstNamePost([FromRoute]id, [FromBody]firstName)
{
   // Change user's first name
}

[HttpPost("id")]
[ActionName("CityPost")]
public void CityPost([FromRoute]id, [FromBody]city)
{
   // Change user's city
}

所以你会调用 "www.mysite.com/api/citypost/1" 或 "www.mysite.com/api/FirstNamePost/1"

另一种选择是只有一个 post 方法并添加第三个参数以区分名称更新或城市更新。

Answer 2

你可以给控制器一个路由前缀

[RoutePrefix("Note")]
public class NoteController

然后给出任何动作的具体路线

[Route("", Name = "Note")]
[HttpGet]
public async Task<IHttpActionResult> Get (string tenantName, [FromBody] TagTdo entity)

[Route("", Name = "CreateNote")]
[HttpPost]        
public async Task<IHttpActionResult> Post (string tenantName, [FromBody] NoteDto entity)

[Route("Update\{id}", Name = "UpdateNote")]
[HttpPut]        
public async Task<IHttpActionResult> Put(string tenantName, [FromBody] NoteDto entity)

那么路线将是：

\Note [GET]
\Note [POST]
\Note\Update [PUT]

还有一个命名约定，不要在路由中使用长名称，用斜线和 http 动词分成几个词

不要使用GetUserContacts，使用User\Contacts [GET]。