SwaggerUI не отображает краткое описание перечисления, ядро ​​C # .net? - PullRequest
0 голосов
/ 13 ноября 2018

Я использовал https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.1&tabs=visual-studio#xml-comments, чтобы показать описание своих классов в SwaggerUI, все нормально, но не отображается enum Краткое описание!
Мой startup.cs

services.AddSwaggerGen(c =>
{   
    c.SwaggerDoc("v1", new Info
    {
        Version = "v1",
        Title = "My App-Service",
        Description = "My Description",
    });
    c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"));  
    c.DescribeAllEnumsAsStrings();
});

Мой enum:

public enum GenderEnum
{
    /// <summary>
    /// Man Description
    /// </summary>
    Man = 1,

    /// <summary>
    /// Woman Description
    /// </summary>
    Woman = 2
}

Это показывает что-то вроде следующего:
Swagger UI enum

Я хочу показать Man Description и Woman Description в SwaggerUI
как это:

Man = 1, Man Description
Woman = 2,  Woman Description


Я использую Swashbuckle.AspNetCore v4.0.1 пакет

1 Ответ

0 голосов
/ 20 ноября 2018

Я решил это, используя атрибут description.Вот пример использования:

public enum GenderEnum
{
    [Description("Man Description")]
    Man = 1,

    [Description("Woman Description")]
    Woman = 2
}
...