C# Swagger UI display Enum with String

2023-04-25

Swagger UI 列舉值 1,2,3 改用文字顯示的方法

結論

新增

src/Project.HttpApi.Host/Swagger/EnumSchemaFilter.cs

internal sealed class EnumSchemaFilter : ISchemaFilter 
{ 
    public void Apply(OpenApiSchema model, SchemaFilterContext context)
    {
        if (!context.Type.IsEnum)
        {
            return;
        }

        model.Enum.Clear(); 
        Enum
            .GetNames(context.Type)
            .ToList()
            .ForEach(name => model.Enum.Add(new OpenApiString($"{name}"))); 
        model.Type = "string"; 
        model.Format = string.Empty;
    } 
}

修改

src/Project.HttpApi.Host/ProjectHttpApiHostModule.cs

options.SchemaFilter<EnumSchemaFilter>();

private static void ConfigureSwaggerServices(
  ServiceConfigurationContext context, 
  IConfiguration configuration)
{
    context.Services.AddAbpSwaggerGenWithOAuth(
        configuration["AuthServer:Authority"],
        new Dictionary<string, string>
        {
            { "Project", "Project API" }
        },
        options =>
        {
            options.SwaggerDoc("v1", new OpenApiInfo { Title = "Project API", Version = "v1" });
            options.DocInclusionPredicate((docName, description) => true);
            options.CustomSchemaIds(type => type.FullName);
            // 使用 Filter
            options.SchemaFilter<EnumSchemaFilter>();
        });
}