API Key not supplied on initial resource listing call.

[watchwithmike]

When loading the Swagger UI with an API key configured, the initial call to the resource listing (i.e. swagger.json) does not include the configured API key. Subsequent calls to the resource listing do have the key appended.

To reproduce:

1. Uncomment the key pre-population code in the sample index.html file.
2. Load the page while viewing the Network tab in your favorite browser development window.
   • Observe swagger.json is pulled from http://petstore.swagger.io/v2/swagger.json
3. Click the Explore button.
   • Observe swagger.json is pulled from http://petstore.swagger.io/v2/swagger.json?api_key=myApiKeyXXXX123456789
   • Note the api_key is appended.

This behavior seems inconsistent. Our resource listings require an access key be provided, is there another way we should be approaching this?

[whitlockjc]

You should be passing your authorizations to the SwaggerUi constructor so they are available when swagger-ui retrieves these documents. If you add the authorizations after you initialize SwaggerUi, they will only be used for subsequent API calls. So your code should look like this:

new SwaggerUi({
// ...
  authorizations: {
    "api_key": new SwaggerClient.ApiKeyAuthorization("X-YOUR-API-KEY-HEADER", "YOUR-API-KEY-VALUE", "query")
  }
// ...
});

[watchwithmike]

Thanks, that did the trick. I added your comments to the README.md and submitted that as a pull request in case it's useful to others.

[mit2nil]

How do I support multiple API keys based on the user? This solution seems to be hardcoded for single user unless I am missing something here.

[fehguy]

@mit2nil you might open a new issue. You can have as many keys as needed based on your securityDefinitions.