Swagger UI setup in Web Api for endpoint and class documentation

Question

I have a solution in VS2013 with several class libraries and a Web API project. I am running into a few problems when setting up Swagger UI. First, when I setup swashbuckle for my Web API project, I can only point to one documentation XML file. Is there a way to point to include multiple XML files so that Swagger not only picks up documentation for my routes in controller but also the domain objects from my other projects as well? Here is my code from SwaggerConfig.cs

SwaggerSpecConfig.Customize
    (
        c =>
        {
            c.IncludeXmlComments(Path.Combine(dirPath, projName + ".xml"));
        }
    );

If I add multiple XML files, it only picks up the last file from IncludeXmlComments.

Second, I am using camel case for my DTOs when returning in JSON

formats.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();

However when I look at the response model and model schema in Response Class in Swagger UI, I see the exact class property names instead of the JSON schema which is returned when an endpoint is hit. Is there a way to show the exact JSON schema in the Swagger UI documentation page?

Lubos · Accepted Answer · 2017-07-26 17:16:02Z

1

I am using version 5.6.0 and multiple XML docs works for me:

var dir = new DirectoryInfo(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "bin"));
foreach (var fi in dir.EnumerateFiles("*.xml"))
{
    c.IncludeXmlComments(fi.FullName);
}

answered Jul 26, 2017 at 17:16

Lubos

1352 silver badges13 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Hamza · Accepted Answer · 2014-10-01 06:01:34Z

0

to add multiple XML File configure swagger like that.

       SwaggerSpecConfig.Customize(c =>
        {
            // single XML Comment Files
            //c.IncludeXmlComments(GetXmlCommentsPath());

            // Multiple XML Comment Files
            string[] paths = GetXmlCommentsPaths();
            foreach (string xmlCommentsPath in paths)
            {
                c.OperationFilter(new ApplyActionXmlComments(xmlCommentsPath))
                    .ModelFilter(new ApplyTypeXmlComments(xmlCommentsPath));
            }
        });

answered Oct 1, 2014 at 6:01

Hamza

411 bronze badge

2 Comments

Kenpachii Over a year ago

I had been tinkering with the code and I do not know how I got it to work. When I use my code above, it works but when I use yours, I only get partial documentation. I will try to revert my code back and use your solution. FYI, in ApplyActionXmlComments and ApplyTypeXmlComments, the constructors require a XPathDocument.

Hamza Over a year ago

It is working for me. I dont know what version you are using but i am using 4.1.0-rc2 prerelease .. and it takes path of file as string.

Quality Catalyst · Accepted Answer · 2016-05-24 01:44:00Z

0

After version 4.1 you can write this:

c.IncludeXmlComments("File1_Path");
c.IncludeXmlComments("File2_Path"));

Collectives™ on Stack Overflow

Swagger UI setup in Web Api for endpoint and class documentation

3 Answers 3

Comments

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related