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 文档中所有其余路径的默认值？

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

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

Answer 1

您的 SecurityDefintions 对象看起来没问题。请注意

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

表示 API 客户端必须同时使用userEmail 身份验证和clientId 身份验证！您可能的意思是：

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

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

为避免一遍又一遍地重复此定义，您可以使用全局 security 属性，该属性适用于没有自己的 security 对象的所有路径：

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: [] } ]

参考

Operation Object 下的 Swagger2 规范声明：

security: [Security Requirement Object]

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

Security Requirement Object 是这样描述的：

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

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

Answer 2

OAS 3：https://swagger.io/docs/specification/authentication/

使用多种身份验证类型

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

security:    # A OR B
  - A
  - B

security:    # A AND B
  - A
    B

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