Блог

Как применить фильтрацию JSON в ответ в .net core webapi

У меня есть конечная точка, которая использует HTTP Get verb и возвращает более 80 полей в JSON, но я хочу возвращать только те поля, которые запрашиваются клиентом на основе некоторых условий where. Не понимаю, как реализовать то же самое и как передавать параметры для селектора и фильтрации от клиента (postman, swagger). Любое быстрое предложение или примерное решение будет полезно для реализации того же самого.

 [HttpGet]
[Route("api/v1/cards")]
public IActionResult Cards(inputParameters,selector,filtering)
{
return OK(----)
}
  

В селекторе клиент передает поля, которые он хочет получить в ответ, а в клиенте фильтрации передает параметр для условия where

Создайте ViewModel и верните его в нем.

Например:

 public class ViewModel
{
    public string Property1 { get; set; }

    public string Property2 { get; set; }

    public int Property3 { get; set; }
}
  

И затем в вашем GET действии:

 [HttpGet]
[Route("api/v1/cards")]
public IActionResult Cards(inputParameters,selector,filtering)
{
    return OK(new ViewModel 
           { 
                Property1 = FromJson.Something, 
                Property2 = FromJson.Something44, 
                Property3 = FromJson.Something79 
           });
}
  

С помощью классов моделей просмотра вы можете возвращать значения в JSON стиле со свойствами, которые вы хотите.

Вы можете использовать библиотеку Automapper и сопоставить модель с ViewModel, установив класс профиля сопоставления.

Сначала добавьте пакеты Automapper и Automapper dependency injection.

Затем добавьте Automapper в класс startup:

     public class Startup
{
    // Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        ...
Mapper.Reset(); // Useful if you're using code-first and migrations.
services.AddAutomapper();
    }

    // Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app)
    {
        ...
    }
}
  

Создайте свою ViewModel, содержащую только необходимые свойства для отправки во внешнее приложение.

 public class CardViewModel
{
public object PropVM1 {get; set;}
public object PropVM2 {get; set;}
public object PropVM3 {get; set;}
...
}
  

Из класса модели:

 public class Card
    {
    public object Prop1 {get; set;}
    public object Prop2 {get; set;}
    public object Prop3 {get; set;}
    public object Prop4 {get; set;}
    public object Prop5 {get; set;}
    ...
    }
  

Затем создайте класс профиля сопоставления, который наследуется от AutoMapper.Профиль:

 public class AppMappingProfile : Profile
{
public AppMappingProfile()
{
CreateMap<Card, CardViewModel>()
   .ForMember(d => d.PropVM1, ex => ex.MapFrom(o => o.Prop1))
   .ForMember(d => d.PropVM2, ex => ex.MapFrom(o => o.Prop2))
   .ForMember(d => d.PropVM3, ex => ex.MapFrom(o => o.Prop3))
   .ReverseMap() // if a two-away Mapping is necessary
}
} 
  

Наконец, добавьте Automapper в свой контроллер:

 public class CardController : Controller
{
private readonly IMapper;
public CardController(IMapper mapper)
{
_mapper = mapper;
}
[HttpGet]
[Route("api/v1/cards")]
public IActionResult Cards(inputParameters,selector,filtering)
{
var result = DoYourThing();

//if a list of cards
if(result != null amp;amp; result.Count > 0) return Ok(_mapper.Map<List<Card>, List<CardViewModel>>(result));
return NoContent();

// if single card object
if(result != null) return Ok(_mapper.Map<Card, CardViewModel>())
return NoContent();
}

}
  

Надеюсь, вы найдете это полезным.

Я решаю проблему с помощью OData, это потрясающе. Вы можете перейти по ссылке, чтобы реализовать OData в вашем .net core api , загрузив свои веб-API с помощью OData и ASP.NET Ядро

Вы могли бы вернуть Dictionary<string, object> и добавить нужные поля в виде записей, подобных этой

 [HttpGet]
[Route("api/v1/cards")]
public IActionResult Cards(inputParameters,selector,filtering)
{
    var result = new Dictionary<string, object>();
    result["variable1"] = "value1";
    if (something == true)
        result["variable2"] = 7;
    return OK(result);
}