为字典< SomeEnum，string >生成摆动

Question

我用的是Swashbuckle。AspNetCore.Swagger生成一个Swagger文档，然后使用NSwag生成一个C# SDK。

我有几节课用字典

namespace Sample
{
    /// <summary>Possible properties for MyClass1 objects</summary>
    [JsonConverter(typeof(StringEnumConverter))]
    public enum PropEnum1
    {
        /// <summary>OpenAPI doesn't see this description</summary>
        PropName1,
        PropName2,
        PropName3,
        // and more property names
    }

    /// <summary>The first class...</summary>
    public class MyClass1
    {
        public string Name { get; set; }

        /// <summary>Properties that vary from instance to instance.</summary>
        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
        public IDictionary<PropEnum1, string> Props { get; set; }
    }

    // There is also a PropEnum2 and MyClass2, but let's stay simple
}

使用Swashbuckle 6.14，我最终得到了看起来像这样的摇摆不定：

"MyClass1": {
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "props": {
      "type": "object",
      "properties": {
        "PropName1": {
          "type": "string"
        },
        "PropName2": {
          "type": "string"
        },
        "PropName3": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "description": "Properties that vary from instance to instance.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "The first class..."
}

然后NSwag生成一个C#接口，如下所示：

/// <summary>The first class...</summary>
[System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "10.4.3.0 (Newtonsoft.Json v12.0.0.0)")]
public partial class MyClass1
{
    [Newtonsoft.Json.JsonProperty("name", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public string Name { get; set; }

    /// <summary>Properties that vary from instance to instance.</summary>
    [Newtonsoft.Json.JsonProperty("props", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public Props Props { get; set; }
}

[System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "10.4.3.0 (Newtonsoft.Json v12.0.0.0)")]
public partial class Props
{
    [Newtonsoft.Json.JsonProperty("PropName1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public string PropName1 { get; set; }

    [Newtonsoft.Json.JsonProperty("PropName2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public string PropName2 { get; set; }

    [Newtonsoft.Json.JsonProperty("PropName3", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public string PropName3 { get; set; }
}

我发现Props类的生成对每个可能的枚举值都有一个成员有点令人惊讶，但我可以接受它。

问题在于 MyClass1 的实例可能不具有所有属性。我有一个返回 MyClass1 实例的 API。它从 swagger 页面工作，但使用 NSwag SDK 会给我一个错误“牛顿软件.Json.Json序列化异常：必需属性 'PropName2' 需要一个非空值。

眼前的问题是生成的 Props 类中的不允许取消。如果我手动编辑它们从“禁用”到“默认”，SDK 将按预期工作。但是手工编辑生成的代码并不好。

不允许取消来自炫耀者中的 PropName 属性，未将“可空”设置为 true。如果我暂停生成过程并将它们手动编辑到 swagger 中，则会在生成的 C# 代码中获得 Required.Default。但手工编辑生成的摇摆不定也不好。

因此，解决这个问题的一个方法是在属性中加入一个“nullable ”,但是我不知道如何去做。

或者有没有办法让斯瓦布克尔把道具字典更像字典一样对待

从这篇文章来看，它就像一本字典

Answer 1

这是我最后的结果。它将类型转换为泛型对象（其中属性必须为value eType。请注意，我已经将枚举序列化为字符串，因此这可能不适合其他人。

    /// <summary>
    /// For properties that are Dictionary[SomeEnum, valueType] alter the schema
    /// so the generated SDK code will be IDictionary[string, valueType].
    /// </summary>
    public class EnumDictionaryToStringDictionarySchemaFilter : ISchemaFilter
    {
        /// <summary>
        /// Apply the schema changes
        /// </summary>
        /// <param name="schema">The schema model</param>
        /// <param name="context">The schema filter context</param>
        public void Apply(OpenApiSchema schema, SchemaFilterContext context)
        {
            // Only for fields that are Dictionary<Enum, TValue>
            //
            if (!context.Type.IsGenericType)
                return;

            if (!context.Type.GetGenericTypeDefinition().IsAssignableFrom(typeof(Dictionary<,>))
                && !context.Type.GetGenericTypeDefinition().IsAssignableFrom(typeof(IDictionary<,>)))
                return;

            var keyType = context.Type.GetGenericArguments()[0];

            if (!keyType.IsEnum)
                return;

            var valueType = context.Type.GetGenericArguments()[1];
            var valueTypeSchema = context.SchemaGenerator.GenerateSchema(valueType, context.SchemaRepository);

            schema.Type = "object";
            schema.Properties.Clear();
            schema.AdditionalPropertiesAllowed = true;
            schema.AdditionalProperties = valueTypeSchema;
        }
    }