如何在Swashbuckle，Swagger和NSwag中使用自定义模型绑定器？

Question

我有一个包含以下端点的ASP.NET Core Web API。

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

    return Ok(models);
}

此端点采用ID列表（例如/models/a,b,c）并返回相应Model个对象的JSON数组。 CsvModelBinder<string>是我编写的IModelBinder的自定义实现，它将ID的CSV列表拆分为IEnumerable<string>，我可以在查询中使用它来查找对象。这一切都很有效。

我现在要做的是使用NSwag生成客户端库，但这证明是有问题的，因为Swashbuckle生成的Swagger将ids参数描述为IEnumerable<string>，而不是{{ 1}}。

选项A：有没有办法告诉Swashbuckle将参数描述为string而不是string？

选项B：有没有办法告诉NSwag在生成请求网址时是否应将此IEnumerable<string>参数编组为CSV？

Answer 1

我明白了。我需要在Startup.cs

中使用MapType（）创建自定义模型

Csv.cs

public class Csv<T> : List<T> where T : IConvertible
{
    public Csv<T> Append(string delimitedValues)
    {
        var splitValues = delimitedValues
            .Split(',', StringSplitOptions.RemoveEmptyEntries)
            .Cast<string>();

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

        this.AddRange(convertedValues);

        return this;
    }

    public override string ToString()
    {
        return this.Aggregate("", (a,s) => $"{a},{s}").Trim(',');
    }
}

Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();

    services.AddSwaggerGen(c =>
    {
        c.IncludeXmlComments(() => new XPathDocument(new FileStream(Path.Combine(PlatformServices.Default.Application.ApplicationBasePath, "MyApi.xml"), FileMode.Open)));
        c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1"});
        c.MapType<Csv<string>>(() => new Schema { Type = "string", Format = "string" });

    });
}

Answer 2

您可以编写自定义操作过滤器（Swashbuckle）或操作处理器（NSwag），将规范中的给定参数转换为纯字符串。