asp.net-core - 仅针对 MVC 核心应用程序中的 API Controller 生成 Swagger/Swashbuckle 文档

Question

我们有一个带有常规 MVC Controller 的 ASP.NET MVC Core 应用程序。此外，我们在 Controllers 文件夹中有一个名为“API”的子文件夹，其中包含少量 API Controller 。

我们在 .AddSwaggerGen 中使用 .IncludeXmlComments 方法来获取项目中的 XML 文档。

但是，它也为我们所有的常规 Controller 获取 XML。

有没有办法过滤掉“常规” Controller ，或者仅选择 API Controller 以包含在 swagger 文档中？

Answer 1

看看DocInclusionPredicate ，它应该可以解决您的问题😉

// Startup.cs
services.AddSwaggerGen(options => 
    options.DocInclusionPredicate((docName, apiDesc) =>
    {
        if (!apiDesc.TryGetMethodInfo(out MethodInfo methodInfo)) return false;

        // Check if methodInfo is in the right assembly
        // or has the right namespace or version etc.
        bool isMethodIncluded = /* true or false */;

        return isMethodIncluded ;
    });
);