Swagger Swashbuckle Asp.NET 核心：显示每个使用的枚举的详细信息

Question

我有以下枚举：

public enum TicketQuestionType
{
    General = 1,
    Billing = 2,
    TMS = 3,
    HOS = 4,
    DeviceManagement = 5
}

和型号class:

public class TicketCreateApi
{
    public string Subject { get; set; }
    public TicketQuestionType QuestionType { get; set; } = TicketQuestionType.General;
    public TicketType Type { get; set; } = TicketType.Problem;
    public TicketStatus Status { get; set; } = TicketStatus.New;
    public TicketPriority Priority { get; set; } = TicketPriority.Normal;
    public string Description { get; set; }
    public List<string> Attachments { get; set; }
    public int? DeviceId { get; set; }
    public int? DriverId { get; set; }
}

我的API方法使用它：

Task<IActionResult> Create(TicketCreateApi model);

Swagger 生成以下内容：

还有这个：

因此，我们只能看到默认值，无法看到可用的枚举列表（名称和值）。我想展示一下。怎么做？

Answer 1

we can see only default value and no way to see available list of enum (names and values). I would like to show it. How to do it?

要在 swagger 中将枚举显示为字符串，您可以配置 JsonStringEnumConverter，在 ConfigureServices 中添加以下行：

        services.AddControllers().AddJsonOptions(options =>
            options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()));

输出如下：

如果您想将枚举显示为 stings 和 int 值，您可以尝试创建一个 EnumSchemaFilter 来更改模式。代码如下：

public class EnumSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema model, SchemaFilterContext context)
    {
        if (context.Type.IsEnum)
        {
            model.Enum.Clear();
            Enum.GetNames(context.Type)
                .ToList()
                .ForEach(name => model.Enum.Add(new OpenApiString($"{Convert.ToInt64(Enum.Parse(context.Type, name))} = {name}")));
        }
    }
}

配置 SwaggerGen 以在 ShemaFilter 之上使用。

        services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new OpenApiInfo
            {
                Version = "v1",
                Title = "ToDo API",
                Description = "A simple example ASP.NET Core Web API",
                TermsOfService = new Uri("https://example.com/terms"),
                Contact = new OpenApiContact
                {
                    Name = "Shayne Boyer",
                    Email = string.Empty,
                    Url = new Uri("https://twitter.com/spboyer"),
                },
                License = new OpenApiLicense
                {
                    Name = "Use under LICX",
                    Url = new Uri("https://example.com/license"),
                }
            });
              
            c.SchemaFilter<EnumSchemaFilter>();
        });

结果是这样的：

Answer 2

我试过枚举架构过滤器。每次提交请求时都会出现一些错误。因为将枚举字符串序列化为 int

我使用了这个代码块，希望它有用

services.AddControllersWithViews()
                    .AddJsonOptions(
                        opts =>
                        {
                            var enumConverter = new JsonStringEnumConverter();
                            opts.JsonSerializerOptions.Converters.Add(enumConverter);
                        });

Swagger Swashbuckle Asp.NET 核心：显示每个使用的枚举的详细信息

Swagger Swashbuckle Asp.NET Core: show details about every enum is used

asp.net-core

asp.net-web-api

swagger

swashbuckle

swashbuckle.aspnetcore