kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1417 from watchwithmike/master

Browse Source 
Updating documentation based on issue swagger-ui issue #1414
This commit is contained in:
Tony Tam
2015-07-22 18:08:36 -07:00
parent d75505fb73 a1ac2b755a
commit 015f1a1dce
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -131,6 +131,17 @@ swaggerUi.api.clientAuthorizations.add("key", new SwaggerClient.ApiKeyAuthorizat
Note! You can pass multiple header params on a single request, just use unique names for them (`key` is used in the above example). Note! You can pass multiple header params on a single request, just use unique names for them (`key` is used in the above example).
If the header parameters are required when loading the `swagger.json`, you will need to pass the authorizations as part of the `SwaggerUi` constructor so they are available when swagger-ui retrieves those documents.
```js
new SwaggerUi({
// ...
authorizations {
"apiKey": new SwaggerClient.ApiKeyAuthorization("X-YOUR-API-KEY-HEADER", "YOUR-API-KEY-VALUE", "header")
},
// ...
});
```
### Localization and translation ### Localization and translation
The localization files are in the [lang](/lang) directory. Note that language files and translator is not included in SwaggerUI by default. You need to add them manually. The localization files are in the [lang](/lang) directory. Note that language files and translator is not included in SwaggerUI by default. You need to add them manually.