Utilizzo di una chiave API e segreto per lo schema di sicurezza Swagger

Question

Swagger supporta la sicurezza di api key, ma sembra essere limitato a un singolo parametro.

C'è un modo per definire un set di parametri (chiave e segreto) che sono previsti come parametri in una richiesta?

Oppure è l'unico modo per saltare lo schema di sicurezza e aggiungere solo quei parametri ad ogni richiesta?

Answer 1

Sì, OpenAPI (Swagger) 2.0 e 3.0 consentono di definire più definizioni di sicurezza e contrassegnare un'operazione come richiesta di più valori, ad esempio una coppia di chiavi API.

Nell'esempio seguente, sto definendo due chiavi API, Key e SecretKey, che devono essere entrambi presenti nelle intestazioni di ciascuna richiesta per poter essere autenticati.

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 

noti che questo è diverso da

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

che significa l'endpoint aspetta sia Key o SecretKey, ma non entrambe.