Swagger - 将多个安全参数添加到同一架构定义中

Aim

在 API 中发出的每个请求中包含多个安全标头

Problem

我正在尝试将多个标头添加到我的 Swagger YAML 安全定义中。 我已经通过 API 进行了搜索，但运气不佳 但我发现在进行“尝试此操作”时，我需要选择一个。而不是两者都可以使用。这是正确的还是我做错了什么？

Snippet

securityDefinitions:
  userEmail:
    type: apiKey
    name: User Email
    in: header
  clientId:
    type: apiKey
    name: Client Id
    in: header

security: [ { userEmail: [], clientId: []  } ]

选择？

如果我试图做到这一点是不可能的...... 是否可以将这些参数指定为 swagger 文档中所有其余路径的默认参数？

这周我是 Swagger 的新手，任何人都发现其他一切都没有问题......但我找不到任何好的例子。

如果可以提供任何指导，那将非常有帮助 非常感谢

Your SecurityDefintions对象看起来不错。当心

security: [ { userEmail: [], clientId: []  } ]

意味着 API 客户端必须使用userEmail身份验证与clientId一次认证！你的意思可能是：

security: [ { userEmail: [] }, { clientId: []  } ]

这意味着 API 客户端必须使用userEmail身份验证或clientId验证。

为了避免一遍又一遍地重复这个定义，你可以使用全局security适用于所有没有自己的路径的属性security object:

security: [ { userEmail: [] }, { clientId: []  } ]
paths:
  "/foo":
    get:
    post:

或者为了明确性或多个共同值而使用参考：

paths:
  "/foo":
    get:
      security:
        "$ref": "#/definitions/lowSecurity"
    post:
      security:
        "$ref": "#/definitions/highSecurity"
definitions:
  lowSecurity:  [ { foo: [] }, { bar: []  } ]
  highSecurity: [ { foo: [] } ]

参考

Swagger2 规范如下操作对象 http://swagger.io/specification/#operationObject:

security: [安全需求对象 http://swagger.io/specification/#securityRequirementObject]

对此操作应用哪些安全方案的声明。值列表描述了可以使用的替代安全方案（即，安全要求之间存在逻辑“或”）。此定义覆盖任何声明的顶级安全性。要删除顶级安全声明，可以使用空数组。

The 安全需求对象 http://swagger.io/specification/#securityRequirementObject是这样描述的：

列出执行此操作所需的安全方案。该对象可以在其中声明多个安全方案，这些方案都是必需的（即方案之间存在逻辑 AND）。

每个属性使用的名称必须对应于安全定义中声明的安全方案。