带着标题和价值大摇大摆

Question

我正在使用 Swashbuckle 为我的 .NET 程序集生成 Swagger。我有一个具有非顺序和负值的枚举。像下面这样

[JsonConverter(typeof(StringEnumConverter))]
public enum ShiftDayOffRule
{
    /// <summary>
    /// Shift has no day off rule.
    /// </summary>
    None = 0,       // DayOffNotRequired

    /// <summary>
    /// If shift with this rule is scheduled then next day must be a day off.
    /// </summary>
    OffAfter = 1,   // DayOffAfter <=> next is off

    /// <summary>
    /// If shift with this rule is scheduled then previous day must be a day off.
    /// </summary>
    OffBefore = -1, // DayOffBefore <=> previous is off

    /// <summary>
    /// If shift with this rule is scheduled then next day must be a work day.
    /// </summary>
    InAfter = 3     // DayInAfter <=> next cannot be off 
};

这些值被重新排序为 0、1、2、3 而不是 0、1、-1、3。

如何让输出 json 包含标题和值，例如：

"dayoffRule": { 
   "description": "Day off rule for the shift. ScheduleData.Enums.ShiftDayOffRule", 
   "enum": [ 
      {"title": "None", "value": 0}, 
      {"title": "OffAfter", "value": 1}, 
      {"title": "InAfter", "value": 3}, 
      {"title": "OffBefore", "value": -1} 
    ], 
    "type": "string" 
 }

Answer 1

在您的配置中启用DescribeAllEnumsAsStrings。
这会将您的枚举更改为如下所示：

    "parameters": [
      {
        "name": "dayOffRule",
        "in": "query",
        "required": true,
        "type": "string",
        "enum": [
          "None",
          "OffAfter",
          "OffBefore",
          "InAfter"
        ]
      }
    ],

你不需要同时拥有title和value...

这是一个现场示例：
http://swashbuckletest.azurewebsites.net/swagger/ui/index?filter=Def#/Default/Default_Post

如果您绝对需要包含一个映射（标题：值），您可以使用 SchemaFilter 将其注入示例中，代码如下：

    private class EnumExampleSchemaFilter : ISchemaFilter
    {
        public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
        {
            if (type == typeof(ShiftDayOffRule))
            {
                var example = new Dictionary<string, int>();
                foreach (var item in Enum.GetValues(typeof(ShiftDayOffRule)))
                {
                    example.Add(item.ToString(), (int)item);
                }
                schema.example = example;
            }
        }
    }

这是 swagger 文档中的样子

    "Value": {
      "enum": [
        "None",
        "OffAfter",
        "OffBefore",
        "InAfter"
      ],
      "type": "string",
      "readOnly": true,
      "example": {
        "None": 0,
        "OffAfter": 1,
        "InAfter": 3,
        "OffBefore": -1
      }
    }