Swashbuckle - 在招摇文档中将字符串视为枚举

Question

我正在使用 FluentValidation，我只想从 fluent 验证器接收我的自定义错误。这就是为什么我在请求类中的所有属性都是字符串的原因。但是，我也希望有更好的枚举类型文档。

这是我的示例请求：

 public class AddNewPaymentRequest
 {
     [EnumDataType(typeof(PaymentStatus))]
     public string PaymentStatus { get; set; }

     public string Id { get; set; }
 }

和示例枚举：

 public enum PaymentStatus
 {
     Unknown,
     New,
     Pending,
     Completed
 }

和控制器：

[HttpPost]
public async Task<ActionResult> PostAsync([FromBody] AddNewPaymentRequest request)
{
   ...
}

我想让这个 EnumDataType 作为 Swagger 显示枚举描述的信息，而不是字符串 destrction。我希望 Swagger 将此字符串视为枚举。

实际结果： click

预期结果： click

有没有可能以这种方式配置 Swashbuckle？

Answer 1

我猜我们说的是 .NET Core

如果你没问题，可以将其明确定义为枚举而不是字符串

 public class AddNewPaymentRequest
 {
     //[EnumDataType(typeof(PaymentStatus))]
     //public string PaymentStatus { get; set; }

     public PaymentStatus PaymentStatus { get; set; }

     public string Id { get; set; }
 }

然后您可以定义 SwaggerGen 如何处理枚举

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

如果您在通过您的 api 接收/发送数据时遇到序列化/反序列化枚举（由 Newtonsoft.Json 编写）的问题，您可以对转换采取更多控制器（如有必要）

 [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
 public enum PaymentStatus
 {
     [EnumMember(Value = "Unknwon")]
     Unknown,

     [EnumMember(Value = "New")]
     New,

     [EnumMember(Value = "Pending")]
     Pending,

     [EnumMember(Value = "Completed")]
     Completed,

     [EnumMember(Value = "something_different_with_underline")]
     SomethingDifferentWithUnderline
 }

请注意，这些枚举的 ToString() 可能会导致不同的字符串（带/不带）下划线

Answer 2

Swaggers 仅支持 RequiredAttribute、ObsoleteAttribute 和 MetaData（用于外部类）。 所以除了写这样的东西之外，没有办法描述公认的价值观：

/// <summary> Allowed values are....