對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 
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，但不能同時使用。