Class Library with Models not getting Xml Comments using Swagger

Question

I have a .net core 2.1 class library for my models that I use in multiple asp.net core web api projects. I am using Swagger(version 3.0.0) for my API documentation. The Xml Comments are NOT displayed for the models in the class library. Yes, I have IncludeXmlComments in my Startup.cs. How do I get the Xml Comments working in my models class library?

NOTE: My models in my Projects directory are documented correctly by Swagger.

Here is where I include the Xml comments:

services.AddSwaggerGen(c => { 
    c.SwaggerDoc("v1", new Info { Title = "Web API", Version = "v1" }); 
    c.IncludeXmlComments($@"{System.AppDomain.CurrentDomain.BaseDirectory}\ABC.Application.WebApi.xml"); 
});

Can you share some of your code, specifically the part where you use the IncludeXmlComments — Helder Sepulveda
– Helder Sepulveda, Commented Aug 15, 2018 at 15:29
Here is where I include the Xml comments: services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "Web API", Version = "v1" }); c.IncludeXmlComments($@"{System.AppDomain.CurrentDomain.BaseDirectory}\ABC.Application.WebApi.xml"); }); — Rich Blumer
– Rich Blumer, Commented Aug 16, 2018 at 13:13
Looks like you have only one IncludeXmlComments but you should have at least two one for your WebApi and the other for the class library that has your models. — Helder Sepulveda
– Helder Sepulveda, Commented Aug 16, 2018 at 18:17

scw · Accepted Answer · 2021-10-07 04:35:34Z

3

Any referenced assemblies will have to be added individually. ABC.Application.WebApi.xml will not contain xml comments from your shared models class.

services.AddSwaggerGen(c => { 
    c.SwaggerDoc("v1", new Info { Title = "Web API", Version = "v1" }); 
    c.IncludeXmlComments($@"{System.AppDomain.CurrentDomain.BaseDirectory}\ABC.Application.WebApi.xml"); 
    c.IncludeXmlComments($@"{System.AppDomain.CurrentDomain.BaseDirectory}\YourSharedClass.Models.xml"); 
});

You may need to copy the model xml to your project. Reference: Add NuGet package XML documentation to Swagger

answered Oct 7, 2021 at 4:35

scw

5,7108 gold badges40 silver badges50 bronze badges

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

Collectives™ on Stack Overflow

Class Library with Models not getting Xml Comments using Swagger

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related