使用API密钥

Question

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

有没有办法定义一组参数(key和secret)作为请求中的参数？

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

Answer 1

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

在下面的示例中，我定义了两个API密钥，Key和SECKey，这两个密钥都应该存在于每个请求的标头中，以便进行身份验证。

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

这意味着endpoint需要密钥或密钥，但不是两者兼而有之。