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