Swashbuckle 如何将 OneOf 声明添加到 OpenAPI 3

Question

我有一个请求 object 可以是 2 种字符串类型“A”或“B”。

注意：这是我真正想要的一个更简单的例子。 枚举在这里对我不起作用。

public class SampleRequest
    {
        //Can only be "A" or "B"
        public string Property1 { get; set; }
    }

我正在尝试创建一个模式过滤器，它可以将 output 作为 OpenAPI“OneOf”属性。

https://datatracker.ietf.org/doc/html/draft-fge-json-schema-validation-00#section-5.5.5

https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/#oneof

https://github.com/domaindrivendev/Swashbuckle.AspNetCore#schema-filters

public class CustomSchemaFilter : ISchemaFilter
    {
        public void Apply(OpenApiSchema schema, SchemaFilterContext context)
        {

            schema.OneOf = new List<OpenApiSchema>
            {

                new OpenApiSchema {Type = "string", Description = "A"},
                new OpenApiSchema {Type = "string", Description = "B"}
            };
            
        }
    }

运行 swagger 时，swagger-ui 正确呈现“oneOf”描述：

oneOf: List [ OrderedMap { "type": "string", "description": "A" }, OrderedMap { "type": "string", "description": "B" } ]

然而，我期待它的价值看起来更像

oneOf: [ "A", "B" ]

这可能吗？ 阅读我的 swagger 文档的人不会知道 OrderedMap 列表是什么。

Answer 1

In C# .NET Core 5: In order to automatically resolve oneOf (polymorphism) at compile-time for your swagger.json , add the following line in your Startup.cs :

public void ConfigureServices(IServiceCollection services){
     services.AddSwaggerGen(c => {c.UseOneOfForPolymorphism();})
}

对于其他一切，您可以遵循OpenAPI 3.0 的文档。