使用Swashbuckle和ASP.NET标识限制对Swagger中某些API控制器的访问

Question

所以，我开始使用昂首阔步。我绝对喜欢它的功能，但我对所有方法的可用性有一些怀疑。

据我所知--Swaschbuclke“Auth”方法中包含的所有方法实际上都是关于API本身的，但我在这方面不需要帮助--我的所有API都受到API ID/密钥对的保护。

我想以某种方式使用ASP.NET标识（登录系统）来限制对API页面（/swagger/ui/index）的访问。

有什么办法吗？Swaschbuckle有什么方法吗？有路线/身份黑客攻击吗？

任何帮助都很感激。

Edit1:[apiExplorerSettings(IgnoreApi=true)]属性不是我要找的--它限制了对方法的所有访问，而不管其身份如何。

Answer 1

关于限制您的狂妄文档中单个API的暴露：

虚张声势5.x:

Swashbuckle5.x有一个名为IgnoreObsoleteActions的配置选项（您需要设置它；默认情况下不启用它），如果操作具有[Obsolete]属性，该选项将隐藏操作。

httpConfiguration
    .EnableSwagger(c =>
        {
            c.IgnoreObsoleteActions();
        });

Swashbuckle在IAPIExplorer之上构建了swagger文档。您应该能够添加一个属性--[ApiExplorerSettings(IgnoreApi=true)]--来管理ApiExplorerSettings控制器类或单个控制器方法，以便在生成文档时让资源管理器（以及随后的Swashbuckle）忽略它们。

示例：个人行动

/// Ignore 'GetFoo' in documentation
public class FooBarController
{
    [ApiExplorerSettings(IgnoreApi = true)]
    public Bar GetFoo
    {
       ...
    }

    public Bar GetBar
    {
       ...
    }
}

示例：控制器类

/// Ignore every controller method in FooBarController in documentation
[ApiExplorerSettings(IgnoreApi = true)]
public class FooBarController
{
    public Bar GetFoo
    {
       ...
    }

    public Bar GetBar
    {
       ...
    }
}

更多细节请参见本GitHub问题。我自己在Swashbuckle 4.1.x中也用过这个。