swagger配置白名单

Swagger是一个流行的API文档生成工具，它允许开发者自动生成API文档，并提供RESTful API的交互式测试功能。当提到Swagger配置白名单时，通常是指限制哪些URL或路径可以被Swagger UI展示和扫描。这样做有助于保护敏感信息，只公开那些应该对外公开的API资源。

在Swagger中，你可以通过`securityDefinitions`部分定义一个安全策略，然后在`paths`对象下的每个路径定义里添加`x-swagger-router-controller`或`tags`属性来应用这个策略。例如，在`apispec.yaml`或`.yml`文件中，可能会有类似这样的设置：

securityDefinitions:
  whitelistApiKey:
    type: apiKey
    name: api_key
    in: header

paths:
  /api/public/*:
    x-swagger-router-controller: PublicController
    security:
      - whitelistApiKey: []

  /api/private/{id}:
    x-swagger-router-controller: PrivateController
    tags:
      - private
    security:
      - whitelistApiKey: [ { "api_key": [] } ]

在这个例子中，`/api/public/*`会被认为是白名单API，而访问`/api/private/{id}`则需要提供`api_key`作为header。未包含在白名单里的路径将不会显示在Swagger UI上，也无法通过自动化工具测试。