62
задан 13 December 2016 в 22:51

8 ответов

От документы :

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;}
}
165
ответ дан 31 October 2019 в 13:06

Таким образом, я думаю, что у меня есть подобная проблема. Я ищу чванство для генерации перечислений наряду с интервалом-> строковое отображение. API должен принять интервал. Вопросы чванства-ui меньше, что я действительно хочу, являются генерацией кода с "реальным" перечислением с другой стороны (приложения для Android с помощью модификации в этом случае).

Так от моего исследования это в конечном счете, кажется, предел спецификации OpenAPI, которую использует Чванство. Не возможно указать имена и номера для перечислений.

лучшая проблема я нашел для следования, https://github.com/OAI/OpenAPI-Specification/issues/681, который похож, "возможно, скоро", но затем Чванство должно было бы быть обновлено, и в моем случае Swashbuckle также.

На данный момент мое обходное решение должно было реализовать фильтр документа, который ищет перечисления и заполняет соответствующее описание с содержанием перечисления.

        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());
    }

}

Это приводит к чему-то как следование Вашего чванства-ui так, по крайней мере, можно "видеть то, что Вы делаете": enter image description here

35
ответ дан 31 October 2019 в 13:06

Я хотел использовать ответ 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>();
17
ответ дан 31 October 2019 в 13:06

Для Базовых 3 ASP.Net с библиотекой Newtonsoft JSON

В Startup.cs/ConfigureServices ():

services
    .AddControllersWithViews(...)
    .AddNewtonsoftJson(options => 
        options.SerializerSettings.Converters.Add(new StringEnumConverter()))

Это не требует вызова к options.DescribeAllEnumsAsStrings() в AddSwaggerGen ().

Для Базовых 3 ASP.Net с библиотекой Microsoft JSON

См. ответ @Bashir в основном:

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

И как он описывает, это в настоящее время требует options.DescribeAllEnumsAsStrings().

Для Core 2 ASP.Net

В Startup.cs/ConfigureServices ():

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

Это не требует вызова к options.DescribeAllEnumsAsStrings() в AddSwaggerGen ().

Пред Ядро ASP.Net

Использование эти DescribeAllEnumsAsStrings() подход из принятого ответа.

5
ответ дан 31 October 2019 в 13:06

Я просто сделал это, и это хорошо работает!

Startup.cs

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

Model.cs

public enum ColumnType {
  DATE = 0
}

swagger.json

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

я надеюсь, что это помогает Вам, как он помог мне!

4
ответ дан 31 October 2019 в 13:06

С ядром asp.net 3

using System.Text.Json.Serialization;

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

, Но кажется, что 5.0.0-rc4 Версия Swashbuckle не готова поддерживать это. Таким образом, мы должны использовать опцию (удержанную от использования) в файле конфигурации Swashbuckle, пока он не поддерживает и отражает его как библиотека Newtonsoft.

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

различие между этим ответом и другими ответами пользуется только библиотекой Microsoft JSON вместо Newtonsoft.

3
ответ дан 31 October 2019 в 13:06

напишите код в Startup.cs

services.AddSwaggerGen(c => {
      c.DescribeAllEnumsAsStrings();
    });
2
ответ дан 31 October 2019 в 13:06

.Net Core 3.0

   using Newtonsoft.Json.Converters;

 services
    .AddMvc(options =>
    {
     options.EnableEndpointRouting = false;
     })
    .AddNewtonsoftJson(options => options.SerializerSettings.Converters.Add(new StringEnumConverter()))
0
ответ дан 31 October 2019 в 13:06

Другие вопросы по тегам:

Похожие вопросы: