มีวิธีแสดง enums ทั้งหมดเป็นค่าสตริงในรูปแบบ swagger แทนค่า int หรือไม่?

ฉันต้องการส่งการกระทำ POST และใส่ enums ตามค่าสตริงโดยไม่ต้องดู enum ทุกครั้ง

ฉันลองแล้วDescribeAllEnumsAsStringsแต่เซิร์ฟเวอร์ได้รับสตริงแทนค่า enum ซึ่งไม่ใช่สิ่งที่เรากำลังมองหา

มีใครแก้ปัญหานี้ได้บ้าง?

แก้ไข:

public class Letter 
{
    [Required]
    public string Content {get; set;}

    [Required]
    [EnumDataType(typeof(Priority))]
    public Priority Priority {get; set;}
}


public class LettersController : ApiController
{
    [HttpPost]
    public IHttpActionResult SendLetter(Letter letter)
    {
        // Validation not passing when using DescribeEnumsAsStrings
        if (!ModelState.IsValid)
            return BadRequest("Not valid")

        ..
    }

    // In the documentation for this request I want to see the string values of the enum before submitting: Low, Medium, High. Instead of 0, 1, 2
    [HttpGet]
    public IHttpActionResult GetByPriority (Priority priority)
    {

    }
}


public enum Priority
{
    Low, 
    Medium,
    High
}

จากเอกสาร :

httpConfiguration
    .EnableSwagger(c => 
        {
            c.SingleApiVersion("v1", "A title for your API");

            c.DescribeAllEnumsAsStrings(); // this will do the trick
        });

นอกจากนี้หากคุณต้องการลักษณะการทำงานนี้เฉพาะในชนิดและคุณสมบัติเฉพาะให้ใช้ StringEnumConverter:

public class Letter 
{
    [Required]
    public string Content {get; set;}

    [Required]
    [EnumDataType(typeof(Priority))]
    [JsonConverter(typeof(StringEnumConverter))]
    public Priority Priority {get; set;}
}

สำหรับ ASP.NET Core 3 ที่มีไลบรารี Microsoft JSON (System.Text.Json)

ใน Startup.cs / ConfigureServices ():

services
    .AddControllersWithViews(...) // or AddControllers() in a Web API
    .AddJsonOptions(options => 
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()));

สำหรับ ASP.NET Core 3 ที่มีไลบรารี Json.NET (Newtonsoft.Json)

ติดตั้งSwashbuckle.AspNetCore.Newtonsoftแพคเกจ

ใน Startup.cs / ConfigureServices ():

services
    .AddControllersWithViews(...)
    .AddNewtonsoftJson(options => 
        options.SerializerSettings.Converters.Add(new StringEnumConverter()));
// order is vital, this *must* be called *after* AddNewtonsoftJson()
services.AddSwaggerGenNewtonsoftSupport();

สำหรับ ASP.NET Core 2

ใน Startup.cs / ConfigureServices ():

services
    .AddMvc(...)
    .AddJsonOptions(options => 
        options.SerializerSettings.Converters.Add(new StringEnumConverter()));

Pre-ASP.NET Core

httpConfiguration
    .EnableSwagger(c => 
        {
            c.DescribeAllEnumsAsStrings();
        });

ดังนั้นฉันคิดว่าฉันมีปัญหาที่คล้ายกัน ฉันกำลังมองหา swagger เพื่อสร้าง enums พร้อมกับ int -> string mapping API ต้องยอมรับ int ความผยองมีความสำคัญน้อยกว่าสิ่งที่ฉันต้องการจริงๆคือการสร้างรหัสด้วย enum "จริง" ในอีกด้านหนึ่ง (แอป Android ที่ใช้ชุดติดตั้งเพิ่มเติมในกรณีนี้)

ดังนั้นจากการวิจัยของฉันในที่สุดสิ่งนี้ดูเหมือนจะ จำกัด ข้อกำหนด OpenAPI ที่ Swagger ใช้ ไม่สามารถระบุชื่อและหมายเลขสำหรับ enums ได้

ปัญหาที่ดีที่สุดที่ฉันพบเพื่อติดตามคือhttps://github.com/OAI/OpenAPI-Specification/issues/681ซึ่งดูเหมือนว่า "อาจจะเร็ว ๆ นี้" แต่จากนั้น Swagger จะต้องได้รับการอัปเดตและในกรณีของฉัน Swashbuckle เป็น ดี.

สำหรับตอนนี้วิธีแก้ปัญหาของฉันคือการใช้ตัวกรองเอกสารที่ค้นหา enums และเติมคำอธิบายที่เกี่ยวข้องพร้อมกับเนื้อหาของ enum

        GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                    c.DocumentFilter<SwaggerAddEnumDescriptions>();

                    //disable this
                    //c.DescribeAllEnumsAsStrings()

SwaggerAddEnumDescriptions.cs:

using System;
using System.Web.Http.Description;
using Swashbuckle.Swagger;
using System.Collections.Generic;

public class SwaggerAddEnumDescriptions : IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        // add enum descriptions to result models
        foreach (KeyValuePair<string, Schema> schemaDictionaryItem in swaggerDoc.definitions)
        {
            Schema schema = schemaDictionaryItem.Value;
            foreach (KeyValuePair<string, Schema> propertyDictionaryItem in schema.properties)
            {
                Schema property = propertyDictionaryItem.Value;
                IList<object> propertyEnums = property.@enum;
                if (propertyEnums != null && propertyEnums.Count > 0)
                {
                    property.description += DescribeEnum(propertyEnums);
                }
            }
        }

        // add enum descriptions to input parameters
        if (swaggerDoc.paths.Count > 0)
        {
            foreach (PathItem pathItem in swaggerDoc.paths.Values)
            {
                DescribeEnumParameters(pathItem.parameters);

                // head, patch, options, delete left out
                List<Operation> possibleParameterisedOperations = new List<Operation> { pathItem.get, pathItem.post, pathItem.put };
                possibleParameterisedOperations.FindAll(x => x != null).ForEach(x => DescribeEnumParameters(x.parameters));
            }
        }
    }

    private void DescribeEnumParameters(IList<Parameter> parameters)
    {
        if (parameters != null)
        {
            foreach (Parameter param in parameters)
            {
                IList<object> paramEnums = param.@enum;
                if (paramEnums != null && paramEnums.Count > 0)
                {
                    param.description += DescribeEnum(paramEnums);
                }
            }
        }
    }

    private string DescribeEnum(IList<object> enums)
    {
        List<string> enumDescriptions = new List<string>();
        foreach (object enumOption in enums)
        {
            enumDescriptions.Add(string.Format("{0} = {1}", (int)enumOption, Enum.GetName(enumOption.GetType(), enumOption)));
        }
        return string.Join(", ", enumDescriptions.ToArray());
    }

}

สิ่งนี้ส่งผลให้เกิดสิ่งต่อไปนี้ใน swagger-ui ของคุณอย่างน้อยคุณก็สามารถ "เห็นสิ่งที่คุณกำลังทำอยู่":

ASP.NET Core 3.1

ในการสร้าง enums เป็นสตริงโดยใช้ Newtonsoft JSON คุณต้องเพิ่มการสนับสนุน Newtonsoft อย่างชัดเจนโดยเพิ่มAddSwaggerGenNewtonsoftSupport()ดังต่อไปนี้:

services.AddMvc()
    ...
    .AddNewtonsoftJson(opts =>
    {
        opts.SerializerSettings.Converters.Add(new StringEnumConverter());
    });


services.AddSwaggerGen(...);
services.AddSwaggerGenNewtonsoftSupport(); //

Swashbuckle.AspNetCore.Newtonsoftนี้สามารถใช้ได้ผ่านแพคเกจใหม่ ดูเหมือนว่าทุกอย่างจะทำงานได้ดีหากไม่มีแพ็คเกจนี้นอกเหนือจากการรองรับตัวแปลง enum

ฉันต้องการใช้คำตอบของ rory_za ในแอปพลิเคชัน. NET Core แต่ต้องแก้ไขเล็กน้อยเพื่อให้ใช้งานได้ นี่คือการใช้งานที่ฉันสร้างขึ้นสำหรับ. NET Core

ฉันเปลี่ยนมันด้วยดังนั้นจึงไม่ถือว่าประเภทพื้นฐานคือintและใช้บรรทัดใหม่ระหว่างค่าเพื่อให้อ่านง่ายขึ้น

/// <summary>
/// Add enum value descriptions to Swagger
/// </summary>
public class EnumDocumentFilter : IDocumentFilter {
    /// <inheritdoc />
    public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context) {
        // add enum descriptions to result models
        foreach (var schemaDictionaryItem in swaggerDoc.Definitions) {
            var schema = schemaDictionaryItem.Value;
            foreach (var propertyDictionaryItem in schema.Properties) {
                var property = propertyDictionaryItem.Value;
                var propertyEnums = property.Enum;
                if (propertyEnums != null && propertyEnums.Count > 0) {
                    property.Description += DescribeEnum(propertyEnums);
                }
            }
        }

        if (swaggerDoc.Paths.Count <= 0) return;

        // add enum descriptions to input parameters
        foreach (var pathItem in swaggerDoc.Paths.Values) {
            DescribeEnumParameters(pathItem.Parameters);

            // head, patch, options, delete left out
            var possibleParameterisedOperations = new List<Operation> {pathItem.Get, pathItem.Post, pathItem.Put};
            possibleParameterisedOperations.FindAll(x => x != null)
                .ForEach(x => DescribeEnumParameters(x.Parameters));
        }
    }

    private static void DescribeEnumParameters(IList<IParameter> parameters) {
        if (parameters == null) return;

        foreach (var param in parameters) {
            if (param is NonBodyParameter nbParam && nbParam.Enum?.Any() == true) {
                param.Description += DescribeEnum(nbParam.Enum);
            } else if (param.Extensions.ContainsKey("enum") && param.Extensions["enum"] is IList<object> paramEnums &&
                paramEnums.Count > 0) {
                param.Description += DescribeEnum(paramEnums);
            }
        }
    }

    private static string DescribeEnum(IEnumerable<object> enums) {
        var enumDescriptions = new List<string>();
        Type type = null;
        foreach (var enumOption in enums) {
            if (type == null) type = enumOption.GetType();
            enumDescriptions.Add($"{Convert.ChangeType(enumOption, type.GetEnumUnderlyingType())} = {Enum.GetName(type, enumOption)}");
        }

        return $"{Environment.NewLine}{string.Join(Environment.NewLine, enumDescriptions)}";
    }
}

จากนั้นเพิ่มสิ่งนี้ในConfigureServicesวิธีการของคุณใน Startup.cs:

c.DocumentFilter<EnumDocumentFilter>();

.NET CORE 3.1 และ SWAGGER 5

หากคุณต้องการวิธีง่ายๆในการคัดเลือก enums ผ่านเป็นสตริง:

using System.Text.Json.Serialization;


[JsonConverter(typeof(JsonStringEnumConverter))]
public enum MyEnum
{
    A, B
}

หมายเหตุเราใช้System.Text.Json.Serializationเนมสเปซไม่ใช่Newtonsoft.Json!

หากใครสนใจฉันได้แก้ไขโค้ดเพื่อใช้งานได้

.NET CORE 3และSwagger V5

    public class SwaggerAddEnumDescriptions : IDocumentFilter
{
    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
    {
        // add enum descriptions to result models
        foreach (var property in swaggerDoc.Components.Schemas.Where(x => x.Value?.Enum?.Count > 0))
        {
            IList<IOpenApiAny> propertyEnums = property.Value.Enum;
            if (propertyEnums != null && propertyEnums.Count > 0)
            {
                property.Value.Description += DescribeEnum(propertyEnums, property.Key);
            }
        }

        // add enum descriptions to input parameters
        foreach (var pathItem in swaggerDoc.Paths.Values)
        {
            DescribeEnumParameters(pathItem.Operations, swaggerDoc);
        }
    }

    private void DescribeEnumParameters(IDictionary<OperationType, OpenApiOperation> operations, OpenApiDocument swaggerDoc)
    {
        if (operations != null)
        {
            foreach (var oper in operations)
            {
                foreach (var param in oper.Value.Parameters)
                {
                    var paramEnum = swaggerDoc.Components.Schemas.FirstOrDefault(x => x.Key == param.Name);
                    if (paramEnum.Value != null)
                    {
                        param.Description += DescribeEnum(paramEnum.Value.Enum, paramEnum.Key);
                    }
                }
            }
        }
    }

    private Type GetEnumTypeByName(string enumTypeName)
    {
        return AppDomain.CurrentDomain
            .GetAssemblies()
            .SelectMany(x => x.GetTypes())
            .FirstOrDefault(x => x.Name == enumTypeName);
    }

    private string DescribeEnum(IList<IOpenApiAny> enums, string proprtyTypeName)
    {
        List<string> enumDescriptions = new List<string>();
        var enumType = GetEnumTypeByName(proprtyTypeName);
        if (enumType == null)
            return null;

        foreach (OpenApiInteger enumOption in enums)
        {
            int enumInt = enumOption.Value;

            enumDescriptions.Add(string.Format("{0} = {1}", enumInt, Enum.GetName(enumType, enumInt)));
        }

        return string.Join(", ", enumDescriptions.ToArray());
    }
}

ด้วย asp.net core 3

using System.Text.Json.Serialization;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
         services.AddControllers().AddJsonOptions(options =>
             options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()));

แต่ดูเหมือนว่า Swashbuckle Version 5.0.0-rc4 จะไม่พร้อมรองรับสิ่งนั้น ดังนั้นเราจึงต้องใช้ตัวเลือก (เลิกใช้แล้ว) ในไฟล์กำหนดค่า Swashbuckle จนกว่าจะรองรับและสะท้อนให้เห็นเหมือนไลบรารี Newtonsoft

public void ConfigureServices(IServiceCollection services)
{ 
      services.AddSwaggerGen(c =>
      {
            c.DescribeAllEnumsAsStrings();

ความแตกต่างระหว่างคำตอบนี้กับคำตอบอื่น ๆ คือการใช้ไลบรารี Microsoft JSON แทน Newtonsoft

ตัวแปรของฉันสำหรับ enum stings ที่มีค่า:

กำหนดค่าบริการ:

services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "web server api", Version = "v1" });
                c.SchemaFilter<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}")));
            }
        }
    }

ฉันเพิ่งทำสิ่งนี้และได้ผลดี!

Startup.cs

services.AddSwaggerGen(c => {
  c.DescribeAllEnumsAsStrings();
});

Model.cs

public enum ColumnType {
  DATE = 0
}

swagger.json

type: {
  enum: ["DATE"],
  type: "string"
}

ฉันหวังว่านี่จะช่วยคุณได้ว่ามันช่วยฉันได้อย่างไร!

ใน. net core 3.1 & swagger 5.0.0:

using System.Linq;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

namespace WebFramework.Swagger
{
    public class EnumSchemaFilter : ISchemaFilter
    {
        public void Apply(OpenApiSchema schema, SchemaFilterContext context)
        {
            if (context.Type.IsEnum)
            {
                var enumValues = schema.Enum.ToArray();
                var i = 0;
                schema.Enum.Clear();
                foreach (var n in Enum.GetNames(context.Type).ToList())
                {
                    schema.Enum.Add(new OpenApiString(n + $" = {((OpenApiPrimitive<int>)enumValues[i]).Value}"));
                    i++;
                }
            }
        }
    }

}

และใน Startup.cs:

services.AddSwaggerGen(options =>
            {
                #region  EnumDesc
                options.SchemaFilter<EnumSchemaFilter>();
                #endregion
            });

ฉันได้แก้ไขคำตอบของ Hosam Rehani ให้ทำงานกับ enums ที่เป็นโมฆะและคอลเลกชันของ enums ด้วย คำตอบก่อนหน้านี้ยังใช้งานได้ก็ต่อเมื่อมีการตั้งชื่อคุณสมบัติให้เหมือนกับประเภท ปัญหาทั้งหมดนี้ได้รับการแก้ไขในรหัสด้านล่าง

มันทำงานร่วมกับ. net core 3.x และ swagger 5.x.

อาจมีประสิทธิภาพมากขึ้นโดยไม่ค้นหาประเภท enum สองครั้งในบางกรณี

class SwaggerAddEnumDescriptions : IDocumentFilter
{
    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
    {
        // add enum descriptions to result models
        foreach (var property in swaggerDoc.Components.Schemas.Where(x => x.Value?.Enum?.Count > 0))
        {
            IList<IOpenApiAny> propertyEnums = property.Value.Enum;
            if (propertyEnums != null && propertyEnums.Count > 0)
            {
                property.Value.Description += DescribeEnum(propertyEnums, property.Key);
            }
        }

        // add enum descriptions to input parameters
        foreach (var pathItem in swaggerDoc.Paths)
        {
            DescribeEnumParameters(pathItem.Value.Operations, swaggerDoc, context.ApiDescriptions, pathItem.Key);
        }
    }

    private void DescribeEnumParameters(IDictionary<OperationType, OpenApiOperation> operations, OpenApiDocument swaggerDoc, IEnumerable<ApiDescription> apiDescriptions, string path)
    {
        path = path.Trim('/');
        if (operations != null)
        {
            var pathDescriptions = apiDescriptions.Where(a => a.RelativePath == path);
            foreach (var oper in operations)
            {
                var operationDescription = pathDescriptions.FirstOrDefault(a => a.HttpMethod.Equals(oper.Key.ToString(), StringComparison.InvariantCultureIgnoreCase));
                foreach (var param in oper.Value.Parameters)
                {
                    var parameterDescription = operationDescription.ParameterDescriptions.FirstOrDefault(a => a.Name == param.Name);
                    if (parameterDescription != null && TryGetEnumType(parameterDescription.Type, out Type enumType))
                    {
                        var paramEnum = swaggerDoc.Components.Schemas.FirstOrDefault(x => x.Key == enumType.Name);
                        if (paramEnum.Value != null)
                        {
                            param.Description += DescribeEnum(paramEnum.Value.Enum, paramEnum.Key);
                        }
                    }
                }
            }
        }
    }

    bool TryGetEnumType(Type type, out Type enumType)
    {
        if (type.IsEnum)
        {
            enumType = type;
            return true;
        }
        else if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>))
        {
            var underlyingType = Nullable.GetUnderlyingType(type);
            if (underlyingType != null && underlyingType.IsEnum == true)
            {
                enumType = underlyingType;
                return true;
            }
        }
        else
        {
            Type underlyingType = GetTypeIEnumerableType(type);
            if (underlyingType != null && underlyingType.IsEnum)
            {
                enumType = underlyingType;
                return true;
            }
            else
            {
                var interfaces = type.GetInterfaces();
                foreach (var interfaceType in interfaces)
                {
                    underlyingType = GetTypeIEnumerableType(interfaceType);
                    if (underlyingType != null && underlyingType.IsEnum)
                    {
                        enumType = underlyingType;
                        return true;
                    }
                }
            }
        }

        enumType = null;
        return false;
    }

    Type GetTypeIEnumerableType(Type type)
    {
        if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(IEnumerable<>))
        {
            var underlyingType = type.GetGenericArguments()[0];
            if (underlyingType.IsEnum)
            {
                return underlyingType;
            }
        }

        return null;
    }

    private Type GetEnumTypeByName(string enumTypeName)
    {
        return AppDomain.CurrentDomain
            .GetAssemblies()
            .SelectMany(x => x.GetTypes())
            .FirstOrDefault(x => x.Name == enumTypeName);
    }

    private string DescribeEnum(IList<IOpenApiAny> enums, string proprtyTypeName)
    {
        List<string> enumDescriptions = new List<string>();
        var enumType = GetEnumTypeByName(proprtyTypeName);
        if (enumType == null)
            return null;

        foreach (OpenApiInteger enumOption in enums)
        {
            int enumInt = enumOption.Value;

            enumDescriptions.Add(string.Format("{0} = {1}", enumInt, Enum.GetName(enumType, enumInt)));
        }

        return string.Join(", ", enumDescriptions.ToArray());
    }
}

การใช้ตัวกรองเพิ่มการกำหนดค่าผยองในc.DocumentFilter<SwaggerAddEnumDescriptions>();Startup.cs

เขียนโค้ดภายใน Startup.cs

services.AddSwaggerGen(c => {
      c.DescribeAllEnumsAsStrings();
    });

ฉันพบวิธีแก้ปัญหาที่ดีที่นี่:

@PauloVetor - แก้ไขโดยใช้ ShemaFilter ดังนี้:

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

และใน Startup.cs:

services.AddSwaggerGen(options =>
{
    options.SchemaFilter<EnumSchemaFilter>();
}

สิ่งนี้ไม่สามารถทำได้กับ OpenAPI มาตรฐาน Enums อธิบายด้วยค่าสตริงเท่านั้น

โชคดีที่คุณสามารถทำได้ด้วยส่วนขยายที่ไม่ได้มาตรฐานบางอย่างที่ใช้โดยโปรแกรมสร้างไคลเอนต์ของคุณ

NSwag รองรับ x-enumNames

AutoRest x-ms-enumสนับสนุน

รองรับ Openapi-generator x-enum-varnames

เครื่องกำเนิดไฟฟ้าอื่น ๆ อาจรองรับหนึ่งในส่วนขยายเหล่านี้หรือมีของตัวเอง

ในการสร้างx-enumNamesสำหรับ NSwag ให้สร้างตัวกรองสคีมาต่อไปนี้:

public class EnumSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (context.Type.IsEnum)
        {
            var array = new OpenApiArray();
            array.AddRange(Enum.GetNames(context.Type).Select(n => new OpenApiString(n)));
            // NSwag
            schema.Extensions.Add("x-enumNames", array);
            // Openapi-generator
            schema.Extensions.Add("x-enum-varnames", array);
        }
    }
}

และลงทะเบียนเป็น:

services.AddSwaggerGen(options =>
{
    options.SchemaFilter<EnumSchemaFilter>();
});

หากคุณใช้ newtonsof.json ให้ใช้สิ่งนี้

using Newtonsoft.Json.Converters;


[JsonConverter(typeof(StringEnumConverter))]
public enum MyEnum
{
    A, B
}

หากคุณกำลังใช้ System.Text.Json.Serialization

using System.Text.Json.Serialization;


[JsonConverter(typeof(JsonStringEnumConverter))]
public enum MyEnum
{
    A, B
}

.Net Core 3.0

   using Newtonsoft.Json.Converters;

 services
    .AddMvc(options =>
    {
     options.EnableEndpointRouting = false;
     })
    .AddNewtonsoftJson(options => options.SerializerSettings.Converters.Add(new StringEnumConverter()))

หากเวอร์ชันของผยองคือ 5.5.x คุณต้อง:

1. ติดตั้ง: Install-Package Swashbuckle.AspNetCore.Newtonsoft -Version 5.5.0

2. services.AddSwaggerGenNewtonsoftSupport ();

อ้างอิง: https://github.com/domaindrivendev/Swashbuckle.AspNetCore#systemtextjson-stj-vs-newtonsoft

ASP NET SOLUTION

ในเอกสาร API ของฉันหนึ่ง enum ยังคงแสดงให้เห็นว่าแม้จะมี int StringEnumConverterทรัพย์สินที่ถูกทำเครื่องหมายด้วย เราไม่สามารถใช้การตั้งค่าส่วนกลางสำหรับ enums ทั้งหมดที่กล่าวมาข้างต้น การเพิ่มบรรทัดนี้ใน SwaggerConfig ช่วยแก้ปัญหา:

c.MapType<ContactInfoType>(() => new Schema { type = "string", @enum = Enum.GetNames(typeof(ContactInfoType))});

มีข้อบกพร่องหลายประการที่ฉันพบในคำตอบอื่น ๆ สำหรับสิ่งที่เรากำลังมองหาดังนั้นฉันจึงคิดว่าฉันจะจัดหาสิ่งนี้เอง เรากำลังใช้ ASP.NET Core 3.1 กับ System.Text.Json แต่วิธีการของเราใช้งานได้โดยไม่คำนึงถึง JSON serializer ที่ใช้

เป้าหมายของเราคือยอมรับค่าสตริง enum ที่มีอูฐต่ำกว่าทั้งใน ASP.NET Core API และเอกสารเดียวกันใน Swagger ขณะนี้เรากำลังใช้ประโยชน์[DataContract]และ[EnumMember]ดังนั้นแนวทางคือการใช้ค่าต่ำกว่าตัวอักษรอูฐจากคุณสมบัติมูลค่า EnumMember และใช้ทั่วทั้งกระดาน

enum ตัวอย่างของเรา:

[DataContract]
public class enum Colors
{
  [EnumMember(Value="brightPink")]
  BrightPink,
  [EnumMember(Value="blue")]
  Blue
}

เราจะใช้ค่า EnumMember ใน Swashbuckle โดยใช้ ISchemaFilter ดังต่อไปนี้:

public class DescribeEnumMemberValues : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (context.Type.IsEnum)
        {
            schema.Enum.Clear();

            //Retrieve each of the values decorated with an EnumMember attribute
            foreach (var member in context.Type.GetMembers())
            {
                var memberAttr = member.GetCustomAttributes(typeof(EnumMemberAttribute), false).FirstOrDefault();
                if (memberAttr != null)
                {
                    var attr = (EnumMemberAttribute) memberAttr;
                    schema.Enum.Add(new OpenApiString(attr.Value));
                }
            }
        }
    }
}

เรากำลังใช้แพ็คเกจ NuGet ของบุคคลที่สาม (GitHub repo ) เพื่อให้แน่ใจว่ารูปแบบการตั้งชื่อนี้จะถูกใช้ใน ASP.NET Core ด้วย กำหนดค่าใน Startup.cs ภายใน ConfigureServices ด้วย:

services.AddControllers()
  .AddJsonOptions(opt => opt.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverterWithAttributeSupport()));

สุดท้ายเราต้องลงทะเบียน ISchemaFilter ของเราใน Swashbuckle ดังนั้นให้เพิ่มสิ่งต่อไปนี้ด้วยใน ConfigureServices ():

services.AddSwaggerGen(c => {
  c.SchemaFilter<DescribeEnumMemberValues>();
});