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

Question

目标

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

问题

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

片段

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

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

另类？

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

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

如果能提供任何指导，那将是非常有帮助的，非常感谢

Answer 1

美洲组织3：https://swagger.io/docs/specification/authentication/

某些 REST API 支持多种身份验证类型。安全性部分允许您使用逻辑 OR 和 AND 组合安全要求，以实现所需的结果。安全性使用以下逻辑：

security:    # A OR B
  - A
  - B

security:    # A AND B
  - A
    B

security:    # (A AND B) OR (C AND D)
  - A
    B
  - C
    D

Answer 2

您的 SecurityDefintions 对象看起来没问题。当心

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

这意味着API客户端必须同时使用用户电子邮件身份验证和客户端ID身份验证！你的意思可能是：

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

这意味着API客户端必须使用用户电子邮件身份验证或客户端ID身份验证。

为了避免反复重复此定义，您可以使用全局安全性属性，该属性适用于所有没有自己的安保对象的路径：

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规范在操作对象下声明：

安全：[安全需求对象]

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

安全需求对象的描述如下：

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

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