Swagger Swashbuckle 多态性不适用于接口类型

dan*_*dan 4 c# swagger swashbuckle asp.net-core openapi

通过下面的代码,我试图提及替代模式;它们共享相同的接口,作为响应的类型。

启动.cs

services.AddSwaggerGen(c =>
{
    c.UseOneOfForPolymorphism();
});

app.UseSwagger();
app.UseSwaggerUI(options =>
{
    options.SwaggerEndpoint("/swagger/v1/swagger.json", "v1");
});
Run Code Online (Sandbox Code Playgroud)

楷模

public interface IOutput
{
    string Discriminator { get; }
}

public class OutputA : IOutput
{
    public string Discriminator => GetType().Name;

    public string PropA { get; set; }
}

public class OutputB : IOutput
{
    public string Discriminator => GetType().Name;

    public string PropB { get; set; }
}
Run Code Online (Sandbox Code Playgroud)

控制器

[HttpGet]
[ProducesResponseType(typeof(IOutput), StatusCodes.Status200OK)]
public IActionResult Get()
{
    return Ok();
}
Run Code Online (Sandbox Code Playgroud)

我期望这两种类型OutputA都会OutputB被列为返回类型,但仅IOutput提到:

在此输入图像描述

或者,如果我将 an 更改IOutputinterfaceaclass或 an abstract classthenOutputA并将OutputB被列为有效返回类型:

在此输入图像描述

是否由于 RESTFul/API 标准而不受支持?

或者说这个可以实现吗?

这是一个.NET Core 2.2项目,使用Swashbuckle.AspNetCore v6.2.3

dan*_*dan 9

分享我找到的解决方案,以防万一有人需要它。

AddSwaggerGen()这个想法是通过as 显式添加多态关系SelectSubTypesUsing()

services.AddSwaggerGen(c =>
{
    c.UseOneOfForPolymorphism();
    c.SelectSubTypesUsing(baseType =>
    {
        if (baseType == typeof(IOutput))
        {
            return new[]
            {
                typeof(OutputA),
                typeof(OutputB)
            };
        }
        return Enumerable.Empty<Type>();
    });
});
Run Code Online (Sandbox Code Playgroud)