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

Question

我正在使用 Swagger 来记录我的 .NET C# API，当我的模型在另一个项目上时，Swagger 会崩溃并且不会加载任何东西。

当我从 Visual Studio 加载示例 WebAPI 项目时，它使用同一项目中的模型并且它有效:

但是当我使用其他项目的模型时，它会在加载任何内容之前崩溃。

我有一个 API 项目和一个业务项目。我的模型是在我的 Buisiness 项目中存储的 View 模型(并在其他项目之间共享，因此在那里需要)。

有什么方法可以向 Swagger 指示我的模型定义在哪里？

Answer 1

我在使用 Swashbuckle 5.6.0 时遇到了同样的问题，并设法修复如下。通过如下更改项目属性，在包含项目的模型对象上启用 XML 文档文件。

然后进入api项目的SwaggerConfig.cs文件，添加model object项目的xml注释文件如下。

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));

现在您将在 swagger 文档上获得模型属性的 xml 注释。