路由不适用于具有关系的 Web api

Question

我正在使用 asp.net 核心创建 web api。 api端点根据guidelines here逻辑映射到资源的关系 所以我的 API 看起来像

      http://tax.mydomain.com/api/v1/clients/1/batches/12/start

其中Client 是Batch 的父级，1 是clientid，12 是batchid，Start 是POST 操作方法。

这里是对应的控制器

public class TaxController : Controller
{
    [HttpPost]
    [Route("clients/{clientid}/batches/{batchid}/start")]
    public void Start([FromRoute]string clientId, [FromRoute]string batchId, 
                      [FromBody]IEnumerable<string> urls)
    {
       // do something
    }
}

因为api/v1 对所有控制器都是通用的，所以我在启动的Configure 方法中配置了它。我也希望Home 作为默认控制器。

    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
      app.UseMvc(routes =>
      {
        routes.MapRoute("default","api/v1/{controller=Home}/{action=Index}/{id?}");
      });
    }

但是客户端没有找到 api http://tax.mydomain.com/api/v1/clients/1/batches/12/start 的错误

Answer 1

任何没有路由属性的控制器方法都使用基于约定的路由。

当您使用[Route] 属性时，您定义了属性路由，因此该操作/控制器不使用常规路由。因此，您的控制器可以通过

访问

http://tax.mydomain.com/clients/1/batches/12/start

作为一个选项，您可以使用属性路由可以与继承相结合的事实。在整个控制器上设置Route 属性，这将用作路由前缀（与WebApi 中的[RoutePrefix] 属性相同）：

[Route("api/v1")]
public class TaxController : Controller
{

}

来自routing 文档的更一般示例：

[Route("api/[controller]")]
public abstract class MyBaseController : Controller { ... }

public class ProductsController : MyBaseController
{
   [HttpGet] // Matches '/api/Products'
   public IActionResult List() { ... }

   [HttpPost("{id}")] // Matches '/api/Products/{id}'
   public IActionResult Edit(int id) { ... }
}

Answer 2

你的设置有两个问题

1. 您调用http://tax.mydomain.com/clients/1/batches/12/start，但您没有在其中指定控制器名称。此路由查找名为 ClientsController 的控制器。所以正确的网址必须是http://tax.mydomain.com/tax/clients/1/batches/12/start

2. 您似乎正在使用默认的 MVC/Viewbased 路由，但您的 url 建议您使用 WebAPI。

   当您使用 WebAPI 创建 Rest 服务时，您没有任何操作。相反，动作映射到 Http 动词（GET（读取）、PUT（更新/替换）、POST（插入）、DELETE）。

   因此，对于 REST 服务，您的默认路由应如下所示：api/v1/{controller=Home}/{id?}