使用 Swagger 实现 Asp.Net.Core webapi 的 Xml 文档

Question

我使用 asp net core 3.1 Web api。我想将 xml 文档包含到 swagger ui 中。

我在ConfigureServices中使用以下方法：

services.AddOpenApiDocument(...)

在配置中：

 app.UseOpenApi();
 app.UseSwaggerUi3();

我有点困惑，因为许多开发人员使用 AddSwaggerGen 和 UseSwagger，然后使用 IncludeXmlComments() 扩展方法。

问题：

有没有办法在 ASP Net Core 3.1 中使用内置库包含 xml 注释？

如果是，包含 Xml 注释的正确方法是什么？

我应该安装 Swashbuckle.AspNetCore 吗？

Answer 1

您需要将以下代码添加到您的.csproj

<PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>