Codice hard Key Api Valore chiave nell'intestazione quando si utilizza un client Swagger generato

Question

Ho scritto molte API in C# e creato un sito Web di documentazione "Swagger" utilizzando Swashbuckle.

Per le chiamate REST autentiche utilizzo una chiave API nell'intestazione.

ho creato una pagina che consente di scaricare un client specifico per qualsiasi linguaggio di programmazione, come documentato qui: https://generator.swagger.io

vorrei per consentire all'utente di generare un cliente con la propria chiave API in modo che non ha bisogno di imposta manualmente la chiave API nel codice.

Nel mio Swagger JSON ho questa definizione di sicurezza:

"securityDefinitions": { 
    "apiKey": { 
     "type": "apiKey", 
     "description": "API Key Authentication", 
     "name": "X-ApiKey", 
     "in": "header" 
    } 
} 

Nella pagina di Swagger Cliente Generator ho trovato questo modello che permette di impostare le opzioni di clienti, ma non riesco a trovare come (e se) l'API la chiave può essere codificata (o qualsiasi altro tipo di autorizzazione) nel codice client.

GeneratorInput { 
    spec (object, optional), 
    options (object, optional), 
    swaggerUrl (string, optional), 
    authorizationValue (AuthorizationValue, optional), 
    securityDefinition (SecuritySchemeDefinition, optional) 
} 
AuthorizationValue { 
    value (string, optional), 
    type (string, optional), 
    keyName (string, optional) 
} 
SecuritySchemeDefinition { 
    description (string, optional), 
    type (string, optional) 
} 

suppongo devo impostare oggetto AuthorizationValue ma non v'è alcuna documentazione su questo (o io non riesco a trovarlo).

Sarebbe sufficiente essere in grado di avere la lib client generata aggiungere un'intestazione HTTP arbitraria a tutte le richieste.

Nel qual caso potremmo avere aggiungere:

X-ApiKey:{whatever the key is} 

Chiunque ha un'idea?

Grazie mille!

Answer 1

sembra di lavorare per aggiungere semplicemente come parametro per ogni chiamata con un valore predefinito - in modo che il JSON sarebbe avere qualcosa di simile:

"post": { 
       "tags": [ "user" ], 
       "summary": "Creates list of users with given input array", 
       "description": "", 
       "operationId": "createUsersWithListInput", 
       "produces": [ "application/xml", "application/json" ], 
       "parameters": [ 
        { 
         "in": "body", 
         "name": "body", 
         "description": "List of user object", 
         "required": true, 
         "schema": { 
          "type": "array", 
          "items": { "$ref": "#/definitions/User" } 
         } 
        }, 
        { 
         "in": "header", 
         "name": "X-ApiKey", 
         "required": false, 
         "type": "string", 
         "format": "string", 
         "default": "abcdef12345" 
        } 
       ], 
       "responses": { "default": { "description": "successful operation" } } 
      }