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

Question

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

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

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

我正在尝试创建一个可以输出为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-过滤器

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"}
            };
            
        }
    }

运行Swigger时，Swigger ui会正确呈现“One of”描述：

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

然而，我希望它的价值看起来更像

oneOf: [ "A", "B" ]

这可能吗？阅读我的招摇留档的人不会知道什么是List of OrderedMap。

Answer 1

在C#. NET Core 5中：为了在编译时为您的swagger.json自动解析oneOf（多态），请在您的S中添加以下行tartup.cs：

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

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