Swashbuckle - 从另一个项目的Model中向Swagger UI添加模型和示例值

Question

I am using Swagger to document my .NET C# API and when my models are on another project Swagger just crashes and doesn't load anything.

When I load the sample WebAPI Project from Visual Studio it uses the models that are on the same project and it works:

But when I use Models from other project it just crashes before loading anything.

I have an API project and a Business Project. My models are View Models stored(and shared among other projects, therfore needed there) on my Buisiness Project.

Is there any way I can indicate to Swagger where my model definitions are?

Answer 1

I have recently handled a similar scenario when I worked on a web API project which was hosted on IIS. I was required to enable xml documentations for all view models and models from two different projects.

Below is a summary of the main steps of the work:

1. Enable XML documentation for related projects (refer to here )
2. For each project, build it first and then include the xml file in the project. Set the property of the file "Copy to Output Directory" to be "Copy is newer" to ensure it is copied to the bin folder of the server.
3. In the Swagger config, invoke IncludeXmlComments() to include the XML documentation files as suggested by Simon88.

The key point is to ensure all xml documentation files are copied to the bin folder of the host server and Swagger UI knows where they are :-).

By the way, there are few similar questions/answers for this kind of issue. One is here

Hope it helps.

Answer 2

I faced same issue with Swashbuckle 5.6.0 and managed to fixed as follows. Enable XML documentation file on model objects containing project by changing project properties as follows.

Then go to SwaggerConfig.cs file of the api project and add xml comments file of model object project as follows.

c.IncludeXmlComments(string.Format(@"{0}\bin\WebApplication1.XML", System.AppDomain.CurrentDomain.BaseDirectory));
// New code line                            
c.IncludeXmlComments(string.Format(@"{0}\bin\core.XML", System.AppDomain.CurrentDomain.BaseDirectory));

Now you will have xml comments for model properties on swagger doc.

Answer 3

I am actually looking to do the same thing!

In the Swagger config i tried this, where the functions point to my XML documentation files.

c.IncludeXmlComments(GetXmlCommentsPathForControllers());
c.IncludeXmlComments(GetXmlCommentsPathForModels());

It's working fine for the controllers but not much is happening when i document the models.

Answer 4

1. Source
   2. Models
   3. Web App

If the source of Web application and Model are in different projects, you can always generate the metadata xml and copy them as part of the build into a common location inside the web application.

So in this case the edit the project properties of Models to output xml to "..\\WebApp\\bin"

For generating dynamic examples, i would recommend you go through this link .