为 Swagger 安全方案使用 API 密钥和秘密

Question

Swagger 支持api key 的安全性，但这似乎仅限于单个参数。

有没有办法在请求中定义一组参数（密钥和秘密）？

或者是跳过安全方案的唯一方法，只是将这些参数添加到每个请求中？

Answer 1

是的，OpenAPI (Swagger) 2.0 和 3.0 允许您定义多个安全定义并将一个操作标记为需要多个安全性，例如一对 API 密钥。

在下面的示例中，我定义了两个 API 密钥，Key 和 SecretKey，这两个密钥都应该出现在每个请求的标头中才能通过身份验证。

swagger: '2.0'
info:
  version: 0.0.0
  title: Simple API
securityDefinitions:
  key:
    type: apiKey
    in: header
    name: Key
  secret_key:
    type: apiKey
    in: header
    name: SecretKey

# Or if you use OpenAPI 3.0:
# components:
#   securitySchemes:
#     key:
#       type: apiKey
#       in: header
#       name: Key
#     secret_key:
#       type: apiKey
#       in: header
#       name: SecretKey

paths:
  /:
    get:
      # Both 'Key' and 'SecretKey' must be used together
      security:
        - key: []
          secret_key: []
      responses:
        200:
          description: OK

请注意，这与

不同

      security:
        - key: []
        - secret_key: []  # <-- Note the leading dash here

这意味着端点需要Key 或SecretKey，但不能同时使用两者。