访问文档 XML for Blazor.Shared models for API Docs.



我有一个 Blazor "全栈"(ASP.NET 核心托管(解决方案,默认情况下包括三个项目:Blazor.ClientBlazor.ServerBlazor.Shared。我在 Blazor.Server 上有一些 API 控制器,其中一些控制器使用 Blazor.Shared 中的模型。这是默认情况下设置解决方案的方式(使用示例天气预报 API(。我对自己的 API 遵循了相同的模型。

我现在正在尝试将 Swagger 文档添加到我的项目中,但我无法弄清楚如何为Blazor.Shared中的模型添加 XML 文档。因此,我只获得控制器的描述,而不是它们使用的模型。具体来说,我正在尝试在Startup.cs中添加两个xml文档文件:

services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo { Title = "MyProject", Version = "v1" });
options.IncludeXmlComments(Path.Combine(System.AppContext.BaseDirectory, "Blazor.Server.Doc.xml"));
options.IncludeXmlComments(Path.Combine(System.AppContext.BaseDirectory, "Blazor.Shared.Doc.xml"));
});

但是,这里的第二行IncludeXmlComments导致异常,因为System.AppContext.BaseDirectory给了我通往Blazor.Serverbin的路径。共享的 xml 文档位于Blazor.Shared项目中生成的单独bin中。

我一直在四处寻找,但听起来没有支持的方法可以在网络核心中从一个项目到另一个项目的路径,所以我不确定该怎么做。我可以获取通往Blazor.Shared箱的路径吗?还是我应该采取不同的方式?最终:如何从 Blazor.Server 中的 Startup.cs 访问 Blazor.Shared 类的文档 xml?

共享的 xml 文档位于单独的垃圾箱中

为 true,但它们通常在生成时复制到服务器 bin 文件夹中。

我现在正在看一个类似的项目,"它只是有效"。

最新更新