在Swagger下拉列表和json上显示枚举成员友好名称

Question

我试图让枚举显示友好的名称从描述（或任何其他属性）在招摇和响应。还试图解析的友好名称设置在主体/查询字符串在控制器的行动，而不尝试400 Bad请求或任何类型的验证错误。我还注意到的是，自定义的通用JsonConver我也没有正常工作。ReadJson（）方法根本没有被调用。我如何让它工作？

[JsonConverter(typeof(JsonEnumConverter<SortDirectionType>))]
public enum SortDirectionType
{
    [Description("asc")]
    ASCENDING,
    [Description("desc")]
    DESCENDING
}

我正在尝试让swagger-ui显示asc

1. 要么swagger ui抛出客户端验证，并用红线突出显示字段
2. 或者，如果我尝试在swagger之外调用endpoint，它会返回400错误
3. 我能够在action[FromBody]参数中成功使用0,1或ASCENDING、DESCENDING值。然而，这不是预期的。我将接收asc、desc，并希望能够在body模型上成功解析它们，并将其映射到enum属性。另一方面，当json渲染时，它应该渲染友好名称

附加代码：

public class JsonEnumConverter<T> : JsonConverter where T : struct, IComparable, IConvertible, IFormattable
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(T);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var type = typeof(T);

        if (!type.IsEnum) throw new InvalidOperationException();

        var enumDescription = (string)reader.Value;

        return enumDescription.GetEnumValueFromDescription<T>();
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var type = typeof(T);

        if (!type.IsEnum) throw new InvalidOperationException();

        if (value != null)
        {
            if (value is Enum sourceEnum)
            {
                writer.WriteValue(sourceEnum.GetDescriptionFromEnumValue());
            }
        }
    }
}

public static class EnumExtensions
{
    public static string GetDescriptionFromEnumValue(this Enum @enum)
    {
        FieldInfo fi = @enum.GetType().GetField(@enum.ToString());

        DescriptionAttribute[] attributes =
            (DescriptionAttribute[])fi.GetCustomAttributes(
            typeof(DescriptionAttribute),
            false);

        if (attributes != null &&
            attributes.Length > 0)
            return attributes[0].Description;
        else
            return @enum.ToString();
    }

    public static T GetEnumValueFromDescription<T>(this string description)
    {
        var type = typeof(T);

        if (!type.IsEnum)
            throw new InvalidOperationException();

        foreach (var field in type.GetFields())
        {
            if (Attribute.GetCustomAttribute(field,
                typeof(DescriptionAttribute)) is DescriptionAttribute attribute)
            {
                if (attribute.Description == description)
                    return (T)field.GetValue(null);
            }
            else
            {
                if (field.Name == description)
                    return (T)field.GetValue(null);
            }
        }

        throw new ArgumentException($"No matching value for enum {nameof(T)} found from {description}.",$"{nameof(description)}"); // or return default(T);
    }
}

https://github.com/domaindrivendev/Swashbuckle/issues/1318

Answer 1

我在这里想出了一个窍门。这可能不一定是你的解决方案，但如果你能做到这一点，我很高兴能帮上忙。

最终将枚举格式更改为字符串而不是默认下拉列表。这样我就可以将asc/desc值发送到api。Swagger接受了这些值并且没有抛出验证错误。我在. net核心api上编写的转换器也能够很好地转换它们。

c.MapType<SortDirectionType>(() => new Schema { Type = "string", Format = "string" });

除此之外，您可能还希望禁用自动启动 asp.net 核心 2.2 验证的默认行为。不知道为什么他们选择将其设置为默认行为。

services.Configure<ApiBehaviorOptions>(options =>
{
    options.SuppressModelStateInvalidFilter = true;
});

Answer 2

这就是为我所做的：

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

我在这里找到了它