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

Complying with request for changes

Browse Source
This commit is contained in:
Raphaël MARQUES
2017-07-04 09:15:43 +02:00
parent cb9ca7d4bf
commit 8ce2b309d8
3 changed files with 34 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -82,20 +82,17 @@ To use swagger-ui's bundles, you should take a look at the [source of swagger-ui
```javascript ```javascript
const ui = SwaggerUIBundle({ const ui = SwaggerUIBundle({
url: "http://petstore.swagger.io/v2/swagger.json", url: "http://petstore.swagger.io/v2/swagger.json",
dom_id: '#swagger-ui', dom_id: '#swagger-ui',
presets: [ presets: [
SwaggerUIBundle.presets.apis, SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset SwaggerUIStandalonePreset
], ],
plugins: [ plugins: [
SwaggerUIBundle.plugins.DownloadUrl SwaggerUIBundle.plugins.DownloadUrl
], ],
layout: "StandaloneLayout", layout: "StandaloneLayout"
docExpansion: "none", })
apisSorter: "alpha",
operationsSorter: "method"
})
``` ```
#### OAuth2 configuration #### OAuth2 configuration
@@ -140,7 +137,7 @@ spec | A JSON object describing the OpenAPI Specification. When used, the `url`
validatorUrl | By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it to `null` will disable validation. validatorUrl | By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it to `null` will disable validation.
dom_id | The id of a dom element inside which SwaggerUi will put the user interface for swagger. dom_id | The id of a dom element inside which SwaggerUi will put the user interface for swagger.
oauth2RedirectUrl | OAuth redirect URL oauth2RedirectUrl | OAuth redirect URL
apisSorter | Apply a sort to the tag list of each API. It can be 'alpha' (sort by paths alphanumerically) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged. apisSorter | Apply a sort to the tag list of each API. It can be 'alpha' (sort by paths alphanumerically) or a function (see Array.prototype.sort() to know how sort function works). Default is the order detemrined by Swagger-UI.
operationsSorter | Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged. operationsSorter | Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.
configUrl | Configs URL configUrl | Configs URL
parameterMacro | MUST be a function. Function to set default value to parameters. Accepts two arguments parameterMacro(operation, parameter). Operation and parameter are objects passed for context, both remain immutable parameterMacro | MUST be a function. Function to set default value to parameters. Accepts two arguments parameterMacro(operation, parameter). Operation and parameter are objects passed for context, both remain immutable

41
dev-helpers/index.html
View File

@@ -4,26 +4,26 @@
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<title>Swagger UI</title> <title>Swagger UI</title>
<link <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet"> <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
<link rel="stylesheet" type="text/css" href="./swagger-ui.css"> <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32"/> <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16"/>
<style> <style>
html { html
{
box-sizing: border-box; box-sizing: border-box;
overflow: -moz-scrollbars-vertical; overflow: -moz-scrollbars-vertical;
overflow-y: scroll; overflow-y: scroll;
} }
*, *,
*:before, *:before,
*:after { *:after
{
box-sizing: inherit; box-sizing: inherit;
} }
body { body {
margin: 0; margin:0;
background: #fafafa; background: #fafafa;
} }
</style> </style>
@@ -67,14 +67,14 @@
<div id="swagger-ui"></div> <div id="swagger-ui"></div>
<script src="./swagger-ui-bundle.js"></script> <script src="./swagger-ui-bundle.js"> </script>
<script src="./swagger-ui-standalone-preset.js"></script> <script src="./swagger-ui-standalone-preset.js"> </script>
<script> <script>
window.onload = () => { window.onload = function() {
window[ "SwaggerUIBundle" ] = window[ "swagger-ui-bundle" ]; window["SwaggerUIBundle"] = window["swagger-ui-bundle"]
window[ "SwaggerUIStandalonePreset" ] = window[ "swagger-ui-standalone-preset" ]; window["SwaggerUIStandalonePreset"] = window["swagger-ui-standalone-preset"]
// Build a system // Build a system
const ui = window.ui = SwaggerUIBundle({ const ui = SwaggerUIBundle({
url: "http://petstore.swagger.io/v2/swagger.json", url: "http://petstore.swagger.io/v2/swagger.json",
dom_id: '#swagger-ui', dom_id: '#swagger-ui',
presets: [ presets: [
@@ -84,11 +84,10 @@
plugins: [ plugins: [
SwaggerUIBundle.plugins.DownloadUrl SwaggerUIBundle.plugins.DownloadUrl
], ],
layout: "StandaloneLayout", layout: "StandaloneLayout"
docExpansion: "none", })
apisSorter: "alpha",
operationsSorter: "method" window.ui = ui
});
ui.initOAuth({ ui.initOAuth({
clientId: "your-client-id", clientId: "your-client-id",
@@ -98,7 +97,7 @@
scopeSeparator: " ", scopeSeparator: " ",
additionalQueryStringParams: {} additionalQueryStringParams: {}
}) })
}; }
</script> </script>
</body> </body>

2
src/core/index.js
View File

@@ -26,6 +26,8 @@ module.exports = function SwaggerUI(opts) {
urls: null, urls: null,
layout: "BaseLayout", layout: "BaseLayout",
docExpansion: "list", docExpansion: "list",
apisSorter: "alpha",
operationsSorter: "method",
validatorUrl: "https://online.swagger.io/validator", validatorUrl: "https://online.swagger.io/validator",
configs: {}, configs: {},
custom: {}, custom: {},