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

2 回答

• 16

  在项目根目录中创建名为“swagger”的新文件夹 . 文件夹名称应与swagger文档的url相匹配 .

  在新创建的文件夹中添加了新的Web.config文件 .

  <configuration> 
  <system.web> 
  <authorization> 
  <deny users="?" /> 
  </authorization> 
  </system.web> 
  <system.webServer> 
  <modules runAllManagedModulesForAllRequests="true" /> 
  </system.webServer> 
  </configuration>
  

  回答发现here .

  另一种选择是：

  “在我的头脑中，我会说在这里你需要一个DelegatingHandler . ”

  回答发现here .

  回复于 2024-04-24T03:37:06+08:00
• 1

  关于在swagger文档中限制单个API的暴露：

  Swashbuckle 5.x:

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

  示例：配置

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

  更多信息请参见documentation .

  Swashbuckle 4.1.x (or if you don't want to use the obsolete attribute):

  Swashbuckle在IApiExplorer之上构建了一个swagger文档 . 您应该能够添加一个属性 - [ApiExplorerSettings(IgnoreApi = true)] - 来管理ApiExplorer设置控制器类或单个控制器方法，以便在生成文档时让资源管理器（以及随后的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 Issue中的更多细节 . 我自己在Swashbuckle 4.1.x中使用过它 .

  回复于 2024-04-24T03:37:06+08:00