Swagger/Swashbuckle 列出可接受的值？

我已在 Web API 应用程序上成功实现了 Swashbuckle/Swagger，但对输出并不满意。

我的 Web api 方法之一（企业事件日志记录工具）接受复杂对象值的 JSON 对象。

问题在于，当存在可以使用的可接受值的选定列表时，参数会列为字符串对象。我设置了默认值，以便如果发送的内容不正确，我会设置为默认值。

我想我可以添加其他返回可接受值的服务调用，但我宁愿不这样做。

我确实在 Swashbuckle 上实现了架构部分来设置有效的“示例”对象，但它只列出了可能一百种不同组合中的一种。

我能给出的关于这个问题的最好例子如下：

EnterpriseEvent {
   EventType (string, optional),
   SourceSystem (string, optional),
   Company (string, optional),
   Interface (string, optional),
   TransactionType (string, optional),
   EventDateTime (string, optional),
   EventXML (Array[Object], optional),
   Operation (string, optional),
   LoggingLevel (string, optional)
}

SourceSystem 可接受的值类似于“Accounting”或“Payments”或“Portal”。公司的可接受值可以是“子公司 1”或“合作伙伴 1”。

我可以在 Swashbuckle/Swagger 中添加一些内容以将其输出到某个地方吗？

最简单的解决方案是将属性从字符串类型更改为枚举，例如：

// original    
public class EnterpriseEvent {
   public string SourceSystem { get; set; }
}

// change
 public class EnterpriseEvent {
   public SourceSystemType SourceSystem { get; set; }
}
public enum SourceSystemType {  
   Accounting,
   Payments
}   

然而带有空格的枚举是一种痛苦。有一个标准的 .NET 机制来处理这些（用EnumMember属性），但是 swashbuckle 并没有考虑到这一点。

[DataContract]
public enum CompanyType
{
    [EnumMember(Value = "Partner 1")]
    Partner1,
    [EnumMember(Value = "Sub Company 1")]
    SubCompany1
}

See https://github.com/domaindrivendev/Swashbuckle/pull/563/files https://github.com/domaindrivendev/Swashbuckle/pull/563/files

这样你就可以获得 swashbuckle 的修改版本（带有上面的修复）。或者，如果您不想进行自定义 swashbuckle 构建（我可以理解这一点），您可以保持模型不变并实现您的“自己的”模式提供程序，如下所示：

GlobalConfiguration.Configuration 
  .EnableSwagger(c =>
  {
    c.CustomProvider((defaultProvider) => new CustomSwaggerProvider(defaultProvider));
  });       

public class CustomSwaggerProvider: ISwaggerProvider
{
  private readonly ISwaggerProvider m_DefaultProvider;
  public CustomSwaggerProvider(ISwaggerProvider defaultProvider)
  {
    m_DefaultProvider = defaultProvider;
  }

  public SwaggerDocument GetSwagger(string rootUrl, string apiVersion)
  {
    // grab the default schema
    var result = m_DefaultProvider.GetSwagger(rootUrl, apiVersion);
    // adjust
    result.definitions["EnterpriseEvent"]
     .properties["SourceSystem"]
     .@enum = new string[] { "Enum with space 1", "Enum with space 2" };

    return result;
  }
}

EDIT:

如果我理解你的评论，你没有在 web api 中配置字符串作为枚举。以下是快速操作方法：

protected void Application_Start() {
  GlobalConfiguration.Configure((config) => {
    config.Formatters.JsonFormatter.SerializerSettings.Converters.Add(
      new Newtonsoft.Json.Converters.StringEnumConverter());
  });
}