将逗号分隔的查询参数(模型属性)绑定到模型集合(AspNetCore 2.0& Swashbuckle)

时间:2017-10-18 01:23:57

标签: c# asp.net-core swagger asp.net-core-2.0 swashbuckle

这比将逗号分隔的查询参数字符串绑定到这些逗号标记化值的数组有点复杂。

基本上我有一个名为User的简单实体模型:

public class User
{
    public string Name { get; set }
    public int Age { get; set; }
    // rest ommited
}

我希望能够在我的网络API端点中提供多个名称和年龄,例如:

http://localhost/api/data/user/query?name=chris,john,alex&age=28,35

将绑定到用户过滤器的ARRAY(我只是使用实体模型)。 而Swagger也会将测试输入表格显示为您输入的单个用户字段。

如何使用AspDotNetCore 2.0 Web Api和Swashbucke完成此操作,而无需在逗号上创建带字符串和标记化的新模型。我喜欢创建某种Swashbuckle / AspNetCore钩子(带有某些属性的decorate方法参数),然后知道将输入拆分成单独的模型。

我的想法是生成过滤器Expression>使用过滤器值集合过滤来自存储库的数据:

var exampleExpression = entity => (entity.Name.Contains("chris") || entity.Name.Contains("john") || entity.Name.Contains("alex")) && (entity.Age == 28 || entity.Age == 35);

以编程方式生成表达式树,我可以这样做。

我甚至想要在生成过滤器表达式时接受输入并将它们放入字典中进行查找。但我很乐意听到你的想法和解决方案。

1 个答案:

答案 0 :(得分:1)

我知道这样做的唯一方法是编写IModelBinder的自定义实现。我在这里做的事非常相似。

CsvModelBinder.cs

public class CsvModelBinder<T> : IModelBinder where T : IConvertible
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        var fieldName = bindingContext.FieldName;
        var valueProviderResult = bindingContext.ValueProvider.GetValue(fieldName);

        if (valueProviderResult == ValueProviderResult.None)
        {
            return Task.CompletedTask;
        }

        bindingContext.ModelState.SetModelValue(fieldName, valueProviderResult);

        var model = new List<T>();

        foreach(string delimitedString in valueProviderResult.Values)
        {
            var splitValues = delimitedString
                .Split(',')
                .Cast<string>();

            var convertedValues = splitValues
                .Select(str => Convert.ChangeType(str, typeof(T)))
                .Cast<T>();

            model.AddRange(convertedValues);
        }

        bindingContext.Result = ModelBindingResult.Success(model);

        return Task.CompletedTask;
    }
}

ModelsController.cs

[Route("models")]
public class ModelsController : Controller
{
    [HttpGet]
    [Route("{ids}")]
    [Produces(typeof(IEnumerable<Model>))]
    public IActionResult Get
    (
        [ModelBinder(typeof(CsvModelBinder<string>))] IEnumerable<string> ids
    )
    {
        // Get models

        return Ok(models);
    }
}

希望这有帮助!此外,如果您对my related problem有任何见解,那将非常感激。