Web API 2 REST服务高级数据过滤

Question

我的团队目前使用.NET的Web API 2平台实现了REST API（JSON）。 我们有一些有效的网址，例如：

/api/schools 
/api/schools/5000 
/api/occupations 
/api/occupations/22

这是我们的一些数据控制器代码：

public class OccupationsController : ApiController
{
    // /api/Occupations/1991
    public IHttpActionResult GetOccupation(int id)
    {
        var occupation = GetAllOccupations().FirstOrDefault((p) => p.OccupationID == id);
        if (occupation == null)
        {
            return NotFound();
        }
        return Ok(occupation);
    }
    // /api/occupations
    public IEnumerable<Occupation> GetAllOccupations()
    {
        var ctx = new TCOSDBEntities();
        return ctx.Occupations.OrderBy(occupation => occupation.Title);          
    }

}

现在，我们正在引入数据过滤（基于用户复选框的选择），我很好奇如何在现有的API中进行处理，或者是否应该放弃REST进行过滤并尝试使用另一种方法？

这是我们的复选框过滤机制： 复选框UI

如何在REST服务和DataController方法中引入搜索参数？ 例如，如何在字段上获得范围过滤器（例如Cost？）？ 我可以过滤多个字段，例如费用，学费等吗？

Answer 1

根据以上评论：

您应该研究用于Web API的oData实现，您必须安装几个MS NuGet软件包。 之后，它主要用于配置要公开的内容，要限制调用方的任何限制（例如最大页面大小），其余部分则由客户端通过操纵URL进行过滤，分页，排序等来完成。

这里是一个例子：

网址样本

这将检索按名称排序的列表中排名前24的学校，其中学生人数在10到100之间（包括10和100）

/odata/Schools/?$count=true&$top=24&$skip=0&$filter=(numberOfStudents ge 10 and numberOfStudents le 100)&$orderby=name desc

SchoolController.cs

using System.Web.Http;
using System.Web.OData;
using System.Web.OData.Routing;

[ODataRoutePrefix("Schools")]
public sealed class SchoolODataController : ODataController
{
    private DbContext _context; // your DbContext implementation, assume some DbSet<School> with the property name Schools

    public SchoolODataController(DbContext context)
    {
        _context = context;
    }

    [EnableQuery(MaxNodeCount = 200, MaxTop = 100, PageSize = 64 )]
    [ODataRoute]
    [HttpGet]
    public IHttpActionResult Get()
    {
        return Ok(_context.Schools);
    }
}

WebApiConfig.cs

using System.Web.Http;
using System.Web.OData.Builder;
using System.Web.OData.Extensions;

public static class WebApiConfig {
    public static void Register(HttpConfiguration config) {
        // other code
        config.MapODataServiceRoute("odata", "odata", GetModel());
    }

    public static IEdmModel GetModel()
    {
        var builder = new ODataConventionModelBuilder();
        builder.EnableLowerCamelCase();
        var setOrders = builder.EntitySet<SchoolModel>("Schools").EntityType.HasKey(x => new { x.SchoolId });
        return builder.GetEdmModel();
    }
}

NuGet软件包

Install-Package Microsoft.AspNet.OData
Install-Package Microsoft.OData.Core
Install-Package Microsoft.OData.Edm