SwaggerUI not display enum summary description, C# .net core?
1
I used https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.1&tabs=visual-studio#xml-comments to show my classes summaries description in SwaggerUI, it's OK but not show enum summary description !
My 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();
});
My enum:
public enum GenderEnum
{
/// <summary>
/// Man Description
/// </summary>
Man = 1,
/// <summary>
/// Woman Description
/// </summary>
Woman = 2
}
It shows something like following:
I want to show Man Description and Woman Description in SwaggerUI
like this:
Man = 1, Man Description
Woman = 2, Woman Description
I'm using Swashbuckle.AspNetCore v4.0.1 package
c# enums .net-core asp.net-core-webapi swagger-ui
asked Nov 13 '18 at 13:32
Mohammad DayyanMohammad Dayyan
10.2k27109179
add a comment |
1
I used https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.1&tabs=visual-studio#xml-comments to show my classes summaries description in SwaggerUI, it's OK but not show enum summary description !
My 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();
});
My enum:
public enum GenderEnum
{
/// <summary>
/// Man Description
/// </summary>
Man = 1,
/// <summary>
/// Woman Description
/// </summary>
Woman = 2
}
It shows something like following:
I want to show Man Description and Woman Description in SwaggerUI
like this:
Man = 1, Man Description
Woman = 2, Woman Description
I'm using Swashbuckle.AspNetCore v4.0.1 package
c# enums .net-core asp.net-core-webapi swagger-ui
asked Nov 13 '18 at 13:32
Mohammad DayyanMohammad Dayyan
10.2k27109179
1
this is an open issue in swagger github.com/swagger-api/swagger-ui/issues/3873 or github.com/swagger-api/swagger-ui/issues/685
– NinjaDeveloper
Nov 13 '18 at 13:39
@Mohammad just to clarify - do you mean you want to see both the enum values AND descriptions of each value? E.g. something like: "Man- Man Description,Woman- Woman Description".
– Helen
Nov 13 '18 at 15:25
@Helen, Yes exactly
– Mohammad Dayyan
Nov 13 '18 at 16:59
1
Possible duplicate of Swagger UI Web Api documentation Present enums as strings?, specifically this answer.
– Helen
Nov 13 '18 at 17:12
To recap the ^^ linked answer - OpenAPI Specification currently does not support enum value descriptions; the workaround is to include those descriptions in the description of the enum or parameter itself.
– Helen
Nov 13 '18 at 17:15
add a comment |
1
1
1
I used https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.1&tabs=visual-studio#xml-comments to show my classes summaries description in SwaggerUI, it's OK but not show enum summary description !
My 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();
});
My enum:
public enum GenderEnum
{
/// <summary>
/// Man Description
/// </summary>
Man = 1,
/// <summary>
/// Woman Description
/// </summary>
Woman = 2
}
It shows something like following:
I want to show Man Description and Woman Description in SwaggerUI
like this:
Man = 1, Man Description
Woman = 2, Woman Description
I'm using Swashbuckle.AspNetCore v4.0.1 package
c# enums .net-core asp.net-core-webapi swagger-ui
asked Nov 13 '18 at 13:32
Mohammad DayyanMohammad Dayyan
10.2k27109179
I used https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.1&tabs=visual-studio#xml-comments to show my classes summaries description in SwaggerUI, it's OK but not show enum summary description !
My 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();
});
My enum:
public enum GenderEnum
{
/// <summary>
/// Man Description
/// </summary>
Man = 1,
/// <summary>
/// Woman Description
/// </summary>
Woman = 2
}
It shows something like following:
I want to show Man Description and Woman Description in SwaggerUI
like this:
Man = 1, Man Description
Woman = 2, Woman Description
I'm using Swashbuckle.AspNetCore v4.0.1 package
c# enums .net-core asp.net-core-webapi swagger-ui
c# enums .net-core asp.net-core-webapi swagger-ui
asked Nov 13 '18 at 13:32
Mohammad DayyanMohammad Dayyan
10.2k27109179
asked Nov 13 '18 at 13:32
Mohammad DayyanMohammad Dayyan
10.2k27109179
edited Nov 14 '18 at 5:03
Mohammad Dayyan
asked Nov 13 '18 at 13:32
Mohammad DayyanMohammad Dayyan
10.2k27109179
asked Nov 13 '18 at 13:32
Mohammad DayyanMohammad Dayyan
10.2k27109179
asked Nov 13 '18 at 13:32
Mohammad DayyanMohammad Dayyan
10.2k27109179
10.2k27109179
1
this is an open issue in swagger github.com/swagger-api/swagger-ui/issues/3873 or github.com/swagger-api/swagger-ui/issues/685
– NinjaDeveloper
Nov 13 '18 at 13:39
@Mohammad just to clarify - do you mean you want to see both the enum values AND descriptions of each value? E.g. something like: "Man- Man Description,Woman- Woman Description".
– Helen
Nov 13 '18 at 15:25
@Helen, Yes exactly
– Mohammad Dayyan
Nov 13 '18 at 16:59
1
Possible duplicate of Swagger UI Web Api documentation Present enums as strings?, specifically this answer.
– Helen
Nov 13 '18 at 17:12
To recap the ^^ linked answer - OpenAPI Specification currently does not support enum value descriptions; the workaround is to include those descriptions in the description of the enum or parameter itself.
– Helen
Nov 13 '18 at 17:15
add a comment |
1
this is an open issue in swagger github.com/swagger-api/swagger-ui/issues/3873 or github.com/swagger-api/swagger-ui/issues/685
– NinjaDeveloper
Nov 13 '18 at 13:39
@Mohammad just to clarify - do you mean you want to see both the enum values AND descriptions of each value? E.g. something like: "Man- Man Description,Woman- Woman Description".
– Helen
Nov 13 '18 at 15:25
@Helen, Yes exactly
– Mohammad Dayyan
Nov 13 '18 at 16:59
1
Possible duplicate of Swagger UI Web Api documentation Present enums as strings?, specifically this answer.
– Helen
Nov 13 '18 at 17:12
To recap the ^^ linked answer - OpenAPI Specification currently does not support enum value descriptions; the workaround is to include those descriptions in the description of the enum or parameter itself.
– Helen
Nov 13 '18 at 17:15
1
1
this is an open issue in swagger github.com/swagger-api/swagger-ui/issues/3873 or github.com/swagger-api/swagger-ui/issues/685
– NinjaDeveloper
Nov 13 '18 at 13:39
this is an open issue in swagger github.com/swagger-api/swagger-ui/issues/3873 or github.com/swagger-api/swagger-ui/issues/685
– NinjaDeveloper
Nov 13 '18 at 13:39
@Mohammad just to clarify - do you mean you want to see both the enum values AND descriptions of each value? E.g. something like: "
Man - Man Description, Woman - Woman Description".– Helen
Nov 13 '18 at 15:25
@Mohammad just to clarify - do you mean you want to see both the enum values AND descriptions of each value? E.g. something like: "
Man - Man Description, Woman - Woman Description".– Helen
Nov 13 '18 at 15:25
@Helen, Yes exactly
– Mohammad Dayyan
Nov 13 '18 at 16:59
@Helen, Yes exactly
– Mohammad Dayyan
Nov 13 '18 at 16:59
1
1
Possible duplicate of Swagger UI Web Api documentation Present enums as strings?, specifically this answer.
– Helen
Nov 13 '18 at 17:12
Possible duplicate of Swagger UI Web Api documentation Present enums as strings?, specifically this answer.
– Helen
Nov 13 '18 at 17:12
To recap the ^^ linked answer - OpenAPI Specification currently does not support enum value descriptions; the workaround is to include those descriptions in the description of the enum or parameter itself.
– Helen
Nov 13 '18 at 17:15
To recap the ^^ linked answer - OpenAPI Specification currently does not support enum value descriptions; the workaround is to include those descriptions in the description of the enum or parameter itself.
– Helen
Nov 13 '18 at 17:15
add a comment |
1 Answer
1
active
oldest
votes
0
I solved this using a description attribute. Here is an example usage:
public enum GenderEnum
{
[Description("Man Description")]
Man = 1,
[Description("Woman Description")]
Woman = 2
}
answered Nov 20 '18 at 18:30
Tarik TutuncuTarik Tutuncu
46329
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
draft saved
draft discarded
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53282170%2fswaggerui-not-display-enum-summary-description-c-sharp-net-core%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
0
I solved this using a description attribute. Here is an example usage:
public enum GenderEnum
{
[Description("Man Description")]
Man = 1,
[Description("Woman Description")]
Woman = 2
}
answered Nov 20 '18 at 18:30
Tarik TutuncuTarik Tutuncu
46329
add a comment |
0
I solved this using a description attribute. Here is an example usage:
public enum GenderEnum
{
[Description("Man Description")]
Man = 1,
[Description("Woman Description")]
Woman = 2
}
answered Nov 20 '18 at 18:30
Tarik TutuncuTarik Tutuncu
46329
add a comment |
0
0
0
I solved this using a description attribute. Here is an example usage:
public enum GenderEnum
{
[Description("Man Description")]
Man = 1,
[Description("Woman Description")]
Woman = 2
}
answered Nov 20 '18 at 18:30
Tarik TutuncuTarik Tutuncu
46329
I solved this using a description attribute. Here is an example usage:
public enum GenderEnum
{
[Description("Man Description")]
Man = 1,
[Description("Woman Description")]
Woman = 2
}
answered Nov 20 '18 at 18:30
Tarik TutuncuTarik Tutuncu
46329
answered Nov 20 '18 at 18:30
Tarik TutuncuTarik Tutuncu
46329
answered Nov 20 '18 at 18:30
Tarik TutuncuTarik Tutuncu
46329
answered Nov 20 '18 at 18:30
Tarik TutuncuTarik Tutuncu
46329
46329
add a comment |
add a comment |
draft saved
draft discarded
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
draft saved
draft discarded
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53282170%2fswaggerui-not-display-enum-summary-description-c-sharp-net-core%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
1
this is an open issue in swagger github.com/swagger-api/swagger-ui/issues/3873 or github.com/swagger-api/swagger-ui/issues/685
– NinjaDeveloper
Nov 13 '18 at 13:39
@Mohammad just to clarify - do you mean you want to see both the enum values AND descriptions of each value? E.g. something like: "
Man- Man Description,Woman- Woman Description".– Helen
Nov 13 '18 at 15:25
@Helen, Yes exactly
– Mohammad Dayyan
Nov 13 '18 at 16:59
1
Possible duplicate of Swagger UI Web Api documentation Present enums as strings?, specifically this answer.
– Helen
Nov 13 '18 at 17:12
To recap the ^^ linked answer - OpenAPI Specification currently does not support enum value descriptions; the workaround is to include those descriptions in the description of the enum or parameter itself.
– Helen
Nov 13 '18 at 17:15