web-dev-qa-db-ja.com

Swagger UI Web Apiドキュメント文字列として列挙型を提示しますか？

すべての列挙型をint値ではなくswaggerの文字列値として表示する方法はありますか？

POSTアクションを送信し、毎回列挙型を見る必要なく、文字列値に応じて列挙型を配置できるようにしたいと思います。

DescribeAllEnumsAsStringsを試しましたが、サーバーは列挙値の代わりに文字列を受け取りますが、これは探しているものではありません。

誰もこれを解決しましたか？

編集：

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
}
c#asp.net-web-apiasp.net-web-api2swagger-uiswashbuckle
60
user5326354

ドキュメント から：

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;}
}
161
Xavero

だから私は同様の問題があると思う。 int->文字列マッピングとともに列挙型を生成するためにswaggerを探しています。 APIはintを受け入れる必要があります。 swagger-uiはそれほど重要ではありません。私が本当に欲しいのは、反対側に「実際の」列挙型を使用したコード生成です（この場合はレトロフィットを使用するAndroidアプリ）。

私の研究から、これは最終的にSwaggerが使用するOpenAPI仕様の制限のようです。列挙型の名前と番号を指定することはできません。

私が従うことがわかった最高の問題は https://github.com/OAI/OpenAPI-Specification/issues/681 のようですが、「多分もうすぐ」ですが、Swaggerを更新する必要があります、私の場合はスワッシュバックルも同様です。

今のところ、私の回避策は、列挙型を探し、関連する説明に列挙型の内容を入力するドキュメントフィルターを実装することです。

        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で次のような結果が得られるため、少なくとも「何をしているかを確認する」ことができます。 enter image description here

34
Rory

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

次に、これをStartup.csのConfigureServicesメソッドに追加します。

c.DocumentFilter<EnumDocumentFilter>();
17
Gabriel Luci

私はこれをやっただけで、うまくいきます！

Startup.cs

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

Model.cs

public enum ColumnType {
  DATE = 0
}

swagger.json

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

これが私をどのように助けたのかお役に立てば幸いです！

4
Rodrigo Béco

DescribeAllEnumsAsStrings()は私にとってはうまくいきませんでした。OPがサーバーが文字列を受け取り、intを期待していると言ったからです。サーバーが文字列を期待できるようにするには、SerializerSettingsにStringEnumConverterを追加する必要があると思います。さらに、DescribeAllEnumsAsStrings（）を完全に省略できます。

tl; dr：Startup.cs/ConfigureServices（）でこれを行うだけです：

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

startup.cs内にコードを書く

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