asp.net-core - Swagger Swashbuckle Asp.NET Core:显示使用的每个枚举的详细信息
问题描述
我有以下枚举:
public enum TicketQuestionType
{
General = 1,
Billing = 2,
TMS = 3,
HOS = 4,
DeviceManagement = 5
}
和模型类:
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 生成以下内容:
和这个:
因此,我们只能看到默认值,而无法看到可用的枚举列表(名称和值)。我想展示它。怎么做?
解决方案
我们只能看到默认值,无法看到可用的枚举列表(名称和值)。我想展示它。怎么做?
要在 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>();
});
结果是这样的:
推荐阅读
- laravel - 找不到驱动程序 (SQL: select * from information_schema.tables where table_schema = fireflyiii and table_name = migrations)
- java - 尝试制作表格,奇怪的制表符间距
- java - 带有标头和正文参数的排球请求
- laravel - 如何为 URL 使用 Slug
- lance - Lance GG:可以激活游戏暂停吗?
- javascript - 无法使用 jsPDF 获取 div 内容
- ruby - 关键字“singleton_class”的引入会破坏 Ruby 代码或导致其他困难吗?
- javascript - 如何在 .onCreate 云函数触发后更新或设置 Firestore 文档的属性
- sql - SQL JOIN 与 CASE 语句结果
- python - 为什么我在 gpu 上的 keras 中的顺序模型出现(被信号 6:SIGABRT 中断)错误,我该怎么办?