Swagger-Swashbuckle 包含来自依赖 dll 的 xmlcomments

Question

我需要记录一个 asp.net 核心网站 api 并且我正在使用 swagger 和 swashbuckle。

我环顾四周，发现了这个 link 但它太旧了，无法使用 https://github.com/domaindrivendev/Swashbuckle/issues/93

有人可以 show/point 告诉我如何包含来自另一个 dll 的 xml 评论吗？

谢谢

Answer 1

swashbuckle 有两个版本：

如果这个问题的标签是正确的，你的 link 不是你正在使用的版本，但所提供的解决方案仍然应该让你知道你需要做什么。

您可以在 Swashbuckle.AspNetCore 上使用 IncludeXmlComments 添加任意数量的 xml 评论，请参阅此处：
Swashbuckle.AspNetCore.SwaggerGen/Application/SwaggerGenOptions.cs#L259

首先，您需要确保您需要的 xml 注释作为部署的一部分发送到服务器，否则 Swashbuckle 将不会显示不存在的内容...

一种解决方案可能是递归循环查找 XML 文件并使用 IncludeXmlComments 添加它们，如下所示：

public void IncludeAllXmlComments(string folder)
{
  if (!string.IsNullOrEmpty(folder))
  {
    foreach (var name in Directory.GetFiles(folder, "*.XML", SearchOption.AllDirectories))
    {
      IncludeXmlComments(filePath: name);
    }
  }
}

此示例代码仅供参考，不适用于copy/pasta

Swagger-Swashbuckle 包含来自依赖 dll 的 xmlcomments

Swagger-Swashbuckle include xmlcomments from dependent dlls

swagger

swashbuckle

asp.net-core-webapi