WebApi controller summary is not showing on Swagger documentation

Question

When I enable this documentation feature through Swagger I'm able to see all kind of information about my documentation but there is no details about my Controller name detail/description.

How to show controller documentation content like below example?

/// <summary> 

/// Represents the alert api controller class.

/// <summary>

public class XYZController : ApiController
{

}

On enabling swagger I'm not able to see this content any where Represents the XYZ api controller class. here

However I able to see my all method description.

score 39 · Answer 1 · edited Jun 30 '21 at 03:27

39

1.) Right click the project and Edit projname.csproj Add the following

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

2.) Add the following to AddSwaggerGen in ConfigureServices

  // Set the comments path for the Swagger JSON and UI.
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);

For more details goto:

https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-5.0&tabs=visual-studio

edited Jun 30 '21 at 03:27

8protons

3,591
5
32
67

answered Nov 21 '20 at 23:49

Sumeet

574
5
5

3

This is the one that helped me the most. – Patrick Knott Mar 05 '21 at 06:27
brillaint thank you – OJB1 Dec 29 '21 at 17:24
awesome solution.... – Vishal modi Apr 11 '22 at 05:24

score 20 · Answer 2 · answered Mar 25 '19 at 09:03

you need to add IncludeXmlComments extension in AddSwaggerGen as below:

 services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1.0", new Info
            {
                Title = "My APIs",
                Version = "v1.0",
                Description = "REST APIs "
            });

            **// Set the comments path for the Swagger JSON and UI.**
            var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
            var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
            c.IncludeXmlComments(xmlPath);            
        });

For more details refer here

score 12 · Answer 3 · answered Apr 15 '20 at 06:09

12

This is possible, See @Liversage answer on this page https://github.com/domaindrivendev/Swashbuckle/issues/572

services.AddSwaggerGen(c =>
{
    var xmlPath = ...;
    c.IncludeXmlComments(xmlPath, includeControllerXmlComments: true);
});

answered Apr 15 '20 at 06:09

Asad Ullah

2,257
2
24
23

", includeControllerXmlComments: true" this part helped me a lot. This was missing for me in order to make it work. Thanks a lot! – Octavian Niculescu Mar 17 '22 at 21:09

score 5 · Answer 4 · answered Feb 03 '17 at 08:36

Is there following code in the SwaggerConfig class?

GlobalConfiguration.Configuration 
            .EnableSwagger(c =>
                {

                    c.IncludeXmlComments(string.Format(@"{0}\bin\YourAssemlyName.XML", System.AppDomain.CurrentDomain.BaseDirectory));

score 5 · Answer 5 · answered Dec 03 '20 at 16:02

As some guys above have reply already, I guess the question was about this:

var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
s.IncludeXmlComments(xmlPath, includeControllerXmlComments: true);

set includeControllerXmlComments: true will allow to take summary of controllers.

score 2 · Answer 6 · answered Apr 26 '17 at 17:32

I think this is related to the following issue : https://github.com/domaindrivendev/Swashbuckle/issues/572

It is currently not possible to display the controller summary, according to the maintainer:

The reason this has been low on the priority list is because it's not something I've run into issues with. You can absolutely describe what every action in your API does using XML comments on your actions.

score 2 · Answer 7 · answered Sep 15 '20 at 07:29

2

in my case, I only needed to mark to use the XML document

  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DocumentationFile>C:...\CertReports.Host.xml</DocumentationFile>

answered Sep 15 '20 at 07:29

ahaliav fox

2,217
22
21

There's a screenshot, but no direction of how to get to the screen... – Taylor Brown Jul 26 '23 at 13:54

score 1 · Answer 8 · answered Sep 03 '21 at 06:53

1

now, in .net core is easy

config.UseControllerSummaryAsTagDescription = true;

answered Sep 03 '21 at 06:53

Ambert Yang

11
2

btw,this is use NSwag's solution – SmRiley Aug 15 '23 at 07:19

WebApi controller summary is not showing on Swagger documentation

8 Answers8

Linked