ASP.NETCore Swagger/OpenAPI 反序列化失败：属性不允许为空

最新推荐文章于 2023-10-03 12:28:52 发布

猿长大人

最新推荐文章于 2023-10-03 12:28:52 发布

阅读量876

点赞数

分类专栏： c# asp.net 文章标签： asp.net swagger c# .net openapi

本文链接：https://blog.csdn.net/lgj123xj/article/details/121956430

版权

c# 同时被 2 个专栏收录

79 篇文章 38 订阅

订阅专栏

asp.net

1 篇文章 0 订阅

订阅专栏

解决ASP.NETCore开发中使用Swagger/OpenAPI时，客户端请求遇到反序列化失败（属性不允许为空）的问题。

创建自定义对象过滤器

public class RequireNonNullablePropertiesSchemaFilter : ISchemaFilter
{
    /// <summary>
    /// Apply 方法将循环检查每个模型属性。将Nullable为false的项添加进添加到Required对象列表中
    /// </summary>
    public void Apply(OpenApiSchema model, SchemaFilterContext context)
    {
        var additionalRequiredProps = model.Properties
            .Where(x => !x.Value.Nullable && !model.Required.Contains(x.Key))
            .Select(x => x.Key);
        foreach (var propKey in additionalRequiredProps)
        {
            model.Required.Add(propKey);
        }
    }
}

配置Swagger

builder.Services.AddSwaggerGen(c => {
    c.SchemaFilter<RequireNonNullablePropertiesSchemaFilter>();     // 添加自定义过滤器
    c.SupportNonNullableReferenceTypes();                           // 支持空引用类型
    c.UseAllOfToExtendReferenceSchemas();                           // 允许枚举为空
    c.UseAllOfForInheritance();                                     // 允许对象为空
});