Web API 2 REST Hizmeti Gelişmiş Veri Filtreleme

Question

Ekibim, .NET için Web API 2 platformunu kullanan bir REST API'sı (JSON) uygulamaktadır. verilerimiz kontrolör kodun bazı edilir burada

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

Ve: Biz şimdi veri filtreleme sunuyoruz

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);   
    } 

} 

(kullanıcı onay kutusu seçime göre) ve ben merak ediyorum Biz gibi bazı çalışma URL'ler, var Mevcut API'mızda buna nasıl yaklaşılacağı, ya da filtreleme için REST'i terk edip farklı bir yaklaşımı hep birlikte denemeli miyim? İşte

bizim onay kutusu mekanizması filtrelediğini: Checkbox UI

nasıl DİNLENME hizmet ve DataController yöntemlerde arama parametrelerini tanıtabilir? Gibi, bir alandaki bir menzil filtresini nasıl alabilirim (Maliyeti?)? Maliyet, Öğrenim, vb. Gibi birden çok alan filtrelemeye sahip olabilir miyim? Yukarıdaki açıklamalar itibaren

Answer 1

:

Web API için OData uygulamaya bakmak gerekir, MS Nuget bir çift yüklemek zorunda paketler vardır. Bundan sonra, ortaya çıkarmak istediğiniz şeyi yapılandırmak, arayanları sınırlamak istediğiniz herhangi bir kısıtlama (maksimum sayfa boyutu gibi) ve geri kalanlar, URL tarafından filtrelenecek, sayfalara, sıralamaya vb. Yönlendirerek istemci tarafından yapılır.

İşte

bir örnek:

URL örnek

Bu öğrenci sayısı dahil 10 ila 100'in

olan adına göre sıralanmış listesinde ilk 24 okulu alır

/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 paketleri

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