.net core Swashbuckle( swagger) 枚举显示值改成显示枚举属性,以及枚举描述

本文介绍了如何在.NET Core的Swashbuckle(Swagger)中将枚举值显示为枚举属性,并展示枚举描述。提供了两种方法,一种是使用SwaggerEnumFilter,另一种是使用EnumSchemaFilter进行注册和实现。详细展示了代码实现和效果。
摘要由CSDN通过智能技术生成

只要在你的ConfigureServices中添加如下代码(两种方案都行)即可:

原创不易转载请注明转载地址,谢谢!

一、把枚举值改成枚举属性

//方法一
services.AddMvc(option => option.EnableEndpointRouting = false).AddJsonOptions(options =>{
    options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
});
//方法二
services.AddControllers().AddJsonOptions(options =>
            options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()));

没改之前

改了之后

枚举

public enum UserType
    {
        /// <summary>
        /// 超级管理员
        /// </summary>
        [Description("超级管理员")]
        Administrator = 1,
        /// <summary>
        /// 高级管理员
        /// </summary>
        [Description("管理员")]
        Admin = 2,
        /// <summary>
        /// 用户
        /// </summary>
        [Description("用户")]
        User = 3
    }

二、显示枚举描述

注意:里面的GetDescription方法时扩展方法,放在了后面

方法一:添加SwaggerEnumFilter类,继承IDocumentFilter,代码如下

using Microsoft.OpenApi.Any;
using Swashbuckle.AspNetCore.SwaggerGen;
using System;
using System.Collections.Generic;
using System.ComponentMo
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值