关于WebAPI REST API设计的问题（表格数据和过滤器视图）

Question

我是RESTful API设计的新手，现在我遇到了一个关于如何设计API的简单问题。

假设一家公司正在运行一项全球服务，我想生成报告向CEO展示我们服务的趋势，以及有多少客户正在使用我们的服务。

报告将显示在UI 3个表：

表1：全球范围内的客户总数，每周数，它有2列：

WeekNo., TotalCustomersCount

表2：每地质客户总数-region，它有3列：

Region, WeekNo. TotalCustomersCount

表3：总的客户每个服务型，i T有3列太：

ServiceType, WeekNo. TotalCustomersCount

我的问题是，我应该如何设计我的API？我不想对待表1,2和3是不同的资源，因为显然，所有这些表都是同一个数据库表上的过滤视图。

============================================== ====================================

我的一个想法是设计API这种方式，但我不知道这是否是正确的方式：

首先，将表1作为资源;

然后，定义〜/ API/totalaccounts的返回结果实体：

public class PivotedTotalCustomers 
{ 
    public string Pivot {get;set;} //if empty or null, means no pivot, which is table 1. 
    public uint WeekNo {get; set;} 
    public uint TotalCustomersCount {get;set;} 
} 

最后，API模板：

/api/{controller}/{pivot},支点是可选的，因此API的样子：

~/api/totalcustomers/ 
~/api/totalcustomers/region 
~/api/totalcustomers/servicetype 

和控制器中的方法：

public IQueryable<PivotedTotalCustomers> GetAllCustomers(); 
public IQueryable<PivotedTotalCustomers> GetPivotedAllCustomers(string pivot); 

Answer 1

如果您使用的是最新版本，2.X，那么你可以使用一个路由属性，如下图所示：

[Route("api/getallcustomers")] 
public IQueryable<PivotedTotalCustomers> GetAllCustomers(); 

您还可以设置订单上的路线，看看老我的问题Multiple GET's in Web API calling wrong action。但是，如果您使用的是旧版本的Web API，那么您需要使用第三方库AttributeRouting（MS实际已在最新版本中实现）。上面的问题将有助于进一步进行属性路由。

您也可以使用配置路由，您可以在本文中看到Routing in ASP.NET Web API。